dev..ce3e31d · squeal · git.iko.soy

git.iko.soy/squeal

36 files changed+1581−2353

unifiedsplit

README.md+6−6

@@ -121,7 +121,7 @@ type Schemas = Public Schema

121121

122122Notice the use of type operators.

123123

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

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

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

126126operator.

127127

@@ -180,8 +180,8 @@ DROP TABLE "emails";

180180DROP TABLE "users";

181181```

182182

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.

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

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

185185

186186```Haskell

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

@@ -189,12 +189,12 @@ We'll need a Haskell type for `User`s. We give the type `SOP.Generic` and

189189>>> instance SOP.HasDatatypeInfo User

190190```

191191

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

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

193193A `Manipulation_` like `insertInto`, `update` or `deleteFrom`

194194has three type parameters, the schemas it refers to, input parameters

195195and an output row. When

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

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

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

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

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

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

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

RELEASE NOTES.md+2−2

@@ -138,11 +138,11 @@ type Expr x

138138 . Expression outer commons grp schemas params from x

139139```

140140

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

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

142142type `(->)`.

143143

144144```Haskell

145−type (-->) x y

145+type (:-->) x y

146146 = forall outer commons grp schemas params from

147147 . Expression outer commons grp schemas params from x

148148 -> Expression outer commons grp schemas params from y

squeal-postgresql/exe/Example.hs+2−2

@@ -53,8 +53,8 @@ setup =

5353 >>>

5454 createTable #emails

5555 ( serial `as` #id :*

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

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

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

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

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

5959 foreignKey #user_id #users #id

6060 OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

squeal-postgresql/squeal-postgresql.cabal+1−8

@@ -25,13 +25,6 @@ library

2525 Squeal.PostgreSQL.Alias

2626 Squeal.PostgreSQL.Binary

2727 Squeal.PostgreSQL.Definition

28− Squeal.PostgreSQL.Definition.Function

29− Squeal.PostgreSQL.Definition.Index

30− Squeal.PostgreSQL.Definition.Table

31− Squeal.PostgreSQL.Definition.Table.Constraint

32− Squeal.PostgreSQL.Definition.Type

33− Squeal.PostgreSQL.Definition.Schema

34− Squeal.PostgreSQL.Definition.View

3528 Squeal.PostgreSQL.Expression

3629 Squeal.PostgreSQL.Expression.Aggregate

3730 Squeal.PostgreSQL.Expression.Collection

@@ -43,7 +36,7 @@ library

4336 Squeal.PostgreSQL.Expression.Null

4437 Squeal.PostgreSQL.Expression.Parameter

4538 Squeal.PostgreSQL.Expression.Range

46− Squeal.PostgreSQL.Expression.Set

39+ Squeal.PostgreSQL.Expression.SetOf

4740 Squeal.PostgreSQL.Expression.Sort

4841 Squeal.PostgreSQL.Expression.Subquery

4942 Squeal.PostgreSQL.Expression.Text

squeal-postgresql/src/Squeal/PostgreSQL.hs+1−8

@@ -195,13 +195,6 @@ module Squeal.PostgreSQL (module X, RenderSQL(..), printSQL) where

195195import Squeal.PostgreSQL.Alias as X

196196import Squeal.PostgreSQL.Binary as X

197197import 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

205198import Squeal.PostgreSQL.Expression as X

206199import Squeal.PostgreSQL.Expression.Aggregate as X

207200import Squeal.PostgreSQL.Expression.Collection as X

@@ -213,7 +206,7 @@ import Squeal.PostgreSQL.Expression.Math as X

213206import Squeal.PostgreSQL.Expression.Null as X

214207import Squeal.PostgreSQL.Expression.Parameter as X

215208import Squeal.PostgreSQL.Expression.Range as X

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

209+import Squeal.PostgreSQL.Expression.SetOf as X

217210import Squeal.PostgreSQL.Expression.Sort as X

218211import Squeal.PostgreSQL.Expression.Subquery as X

219212import Squeal.PostgreSQL.Expression.Text as X

squeal-postgresql/src/Squeal/PostgreSQL/Binary.hs+40−130

@@ -216,9 +216,8 @@ module Squeal.PostgreSQL.Binary

216216 -- * Only

217217 , Only (..)

218218 -- * Oid

219− , OidOf (..)

220− , OidOfParam (..)

221− , OidOfField (..)

219+ , HasOid (..)

220+ , HasAliasedOid (..)

222221 ) where

223222

224223import BinaryParser

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

232231import Data.UUID.Types

233232import Data.Vector (Vector)

234233import Data.Word

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

236234import Generics.SOP

237235import Generics.SOP.Record

238236import GHC.TypeLits

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

246244import qualified Data.Text as Strict (Text)

247245import qualified Data.Text as Strict.Text

248246import qualified Data.Vector as Vector

249−import qualified Database.PostgreSQL.LibPQ as LibPQ

250247import qualified GHC.Generics as GHC

251248import qualified PostgreSQL.Binary.Decoding as Decoding

252249import qualified PostgreSQL.Binary.Encoding as Encoding

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

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

313310 toParam = K . Encoding.jsonb_bytes

314311 . Lazy.ByteString.toStrict . Aeson.encode . getJsonb

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

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

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

317314 toParam = K

318315 . Encoding.array_foldable

319316 (getOid (oidOf @pg)) (unK . toNullityParam @x @ty)

320317 . getVarArray

321−instance (ToParam x pg, OidOf pg)

318+instance (ToParam x pg, HasOid pg)

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

323320 toParam = K

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

325322 . getVarArray

326−instance (ToParam x pg, OidOf pg)

323+instance (ToParam x pg, HasOid pg)

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

328325 toParam = K

329326 . Encoding.nullableArray_vector

330327 (getOid (oidOf @pg)) (unK . toParam @x @pg)

331328 . getVarArray

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

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

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

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

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

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

356353 ( SListI fields

357354 , IsRecord x xs

358355 , AllZip ToField xs fields

359− , All OidOfField fields

356+ , All HasAliasedOid fields

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

361358 toParam =

362359 let

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

364361 encoders = htrans (Proxy @ToField) toField

365362

366363 composite

367− :: All OidOfField row

364+ :: All HasAliasedOid row

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

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

370367 composite fields = K $

@@ -381,18 +378,18 @@ instance

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

382379 let

383380 each

384− :: OidOfField field

381+ :: HasAliasedOid field

385382 => K (Maybe Encoding.Encoding) field

386383 -> Encoding.Encoding

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

388− word32BE (getOid (oidOfField @field))

385+ word32BE (getOid (aliasedOid @field))

389386 <> case field of

390387 Nothing -> int64BE (-1)

391388 Just value ->

392389 int32BE (fromIntegral (builderLength value))

393390 <> value

394391 in

395− hcfoldMap (Proxy @OidOfField) each fields

392+ hcfoldMap (Proxy @HasAliasedOid) each fields

396393

397394 in

398395 composite . encoders . toRecord . getComposite

@@ -401,119 +398,35 @@ instance

401398--

402399-- >>> :set -XTypeApplications

403400-- >>> oidOf @'PGbool

404−-- Oid 16

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

508−

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

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

511−

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

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

514− oidOfField :: Oid

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

516− oidOfField = oidOf @ty

401+-- Oid {getOid = 16}

402+class HasOid (ty :: PGType) where oidOf :: Oid

403+instance HasOid 'PGbool where oidOf = Oid 16

404+instance HasOid 'PGint2 where oidOf = Oid 21

405+instance HasOid 'PGint4 where oidOf = Oid 23

406+instance HasOid 'PGint8 where oidOf = Oid 20

407+instance HasOid 'PGnumeric where oidOf = Oid 1700

408+instance HasOid 'PGfloat4 where oidOf = Oid 700

409+instance HasOid 'PGfloat8 where oidOf = Oid 701

410+instance HasOid ('PGchar n) where oidOf = Oid 18

411+instance HasOid ('PGvarchar n) where oidOf = Oid 1043

412+instance HasOid 'PGtext where oidOf = Oid 25

413+instance HasOid 'PGbytea where oidOf = Oid 17

414+instance HasOid 'PGtimestamp where oidOf = Oid 1114

415+instance HasOid 'PGtimestamptz where oidOf = Oid 1184

416+instance HasOid 'PGdate where oidOf = Oid 1082

417+instance HasOid 'PGtime where oidOf = Oid 1083

418+instance HasOid 'PGtimetz where oidOf = Oid 1266

419+instance HasOid 'PGinterval where oidOf = Oid 1186

420+instance HasOid 'PGuuid where oidOf = Oid 2950

421+instance HasOid 'PGinet where oidOf = Oid 869

422+instance HasOid 'PGjson where oidOf = Oid 114

423+instance HasOid 'PGjsonb where oidOf = Oid 3802

424+

425+-- | Lifts a `HasOid` constraint to a field.

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

427+ aliasedOid :: Oid

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

429+ aliasedOid = oidOf @ty

517430

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

519432-- into the binary format of a PostgreSQL `NullityType`.

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

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

844757replicateMN mx = hsequence' $

845758 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+1293−1

@@ -27,7 +27,6 @@ Squeal data definition language.

2727 , TypeInType

2828 , TypeOperators

2929 , UndecidableSuperClasses

30− , UndecidableInstances

3130#-}

3231

3332module Squeal.PostgreSQL.Definition

@@ -35,16 +34,94 @@ module Squeal.PostgreSQL.Definition

3534 Definition (..)

3635 , (>>>)

3736 , manipDefinition

37+ -- * Tables

38+ -- ** Create

39+ , createSchema

40+ , createSchemaIfNotExists

41+ , createTable

42+ , createTableIfNotExists

43+ , createView

44+ , createTypeEnum

45+ , createTypeEnumFrom

46+ , createTypeComposite

47+ , createTypeCompositeFrom

48+ , FieldTyped (..)

49+ , createDomain

50+ , createTypeRange

51+ , createIndex

52+ , createFunction

53+ , createOrReplaceFunction

54+ , createSetFunction

55+ , createOrReplaceSetFunction

56+ , createBinaryOp

57+ , createLeftOp

58+ , createRightOp

59+ , TableConstraintExpression (..)

60+ , check

61+ , unique

62+ , primaryKey

63+ , foreignKey

64+ , ForeignKeyed

65+ , OnDeleteClause (..)

66+ , OnUpdateClause (..)

67+ , FunctionDefinition(..)

68+ , languageSqlExpr

69+ , languageSqlQuery

70+ -- ** Drop

71+ , dropSchema

72+ , dropTable

73+ , dropView

74+ , dropType

75+ , dropIndex

76+ , dropFunction

77+ , dropOperator

78+ -- ** Alter

79+ , alterTable

80+ , alterTableRename

81+ , AlterTable (..)

82+ , addConstraint

83+ , dropConstraint

84+ , AddColumn (..)

85+ , dropColumn

86+ , renameColumn

87+ , alterColumn

88+ , AlterColumn (..)

89+ , setDefault

90+ , dropDefault

91+ , setNotNull

92+ , dropNotNull

93+ , alterType

94+ -- * Columns

95+ , ColumnTypeExpression (..)

96+ , nullable

97+ , notNullable

98+ , default_

99+ , serial2

100+ , smallserial

101+ , serial4

102+ , serial

103+ , serial8

104+ , bigserial

38105 ) where

39106

40107import Control.Category

41108import Control.DeepSeq

42109import Data.ByteString

43110import Data.Monoid

111+import GHC.TypeLits

44112import Prelude hiding ((.), id)

45113

114+import qualified Generics.SOP as SOP

46115import qualified GHC.Generics as GHC

47116

117+import Squeal.PostgreSQL.Alias

118+import Squeal.PostgreSQL.Expression

119+import Squeal.PostgreSQL.Expression.Logic

120+import Squeal.PostgreSQL.Expression.Sort

121+import Squeal.PostgreSQL.Expression.Type

122+import Squeal.PostgreSQL.List

123+import Squeal.PostgreSQL.PG

124+import Squeal.PostgreSQL.Query

48125import Squeal.PostgreSQL.Manipulation

49126import Squeal.PostgreSQL.Render

50127import Squeal.PostgreSQL.Schema

@@ -80,3 +157,1218 @@ manipDefinition

80157 -- ^ no input or output

81158 -> Definition schemas schemas

82159manipDefinition = UnsafeDefinition . (<> ";") . renderSQL

160+

161+{-----------------------------------------

162+CREATE statements

163+-----------------------------------------}

164+

165+{- |

166+`createSchema` enters a new schema into the current database.

167+The schema name must be distinct from the name of any existing schema

168+in the current database.

169+

170+A schema is essentially a namespace: it contains named objects

171+(tables, data types, functions, and operators) whose names

172+can duplicate those of other objects existing in other schemas.

173+Named objects are accessed by `QualifiedAlias`es with the schema

174+name as a prefix.

175+-}

176+createSchema

177+ :: KnownSymbol sch

178+ => Alias sch

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

180+createSchema sch = UnsafeDefinition $

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

182+

183+{- | Idempotent version of `createSchema`. -}

184+createSchemaIfNotExists

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

186+ => Alias sch

187+ -> Definition schemas schemas

188+createSchemaIfNotExists sch = UnsafeDefinition $

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

190+ <+> renderSQL sch <> ";"

191+

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

193+

194+>>> :set -XOverloadedLabels

195+>>> :{

196+type Table = '[] :=>

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

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

199+:}

200+

201+>>> :{

202+let

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

204+ setup = createTable #tab

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

206+in printSQL setup

207+:}

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

209+-}

210+createTable

211+ :: ( KnownSymbol sch

212+ , KnownSymbol tab

213+ , columns ~ (col ': cols)

214+ , SOP.SListI columns

215+ , SOP.SListI constraints

216+ , Has sch schemas0 schema0

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

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

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

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

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

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

223+ -> Definition schemas0 schemas1

224+createTable tab columns constraints = UnsafeDefinition $

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

226+

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

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

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

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

231+

232+>>> :set -XOverloadedLabels -XTypeApplications

233+>>> :{

234+type Table = '[] :=>

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

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

237+:}

238+

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

240+

241+>>> :{

242+let

243+ setup :: Definition Schemas Schemas

244+ setup = createTableIfNotExists #tab

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

246+in printSQL setup

247+:}

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

249+-}

250+createTableIfNotExists

251+ :: ( Has sch schemas schema

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

253+ , SOP.SListI columns

254+ , SOP.SListI constraints )

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

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

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

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

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

260+ -> Definition schemas schemas

261+createTableIfNotExists tab columns constraints = UnsafeDefinition $

262+ "CREATE TABLE IF NOT EXISTS"

263+ <+> renderCreation tab columns constraints

264+

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

266+renderCreation

267+ :: ( KnownSymbol sch

268+ , KnownSymbol tab

269+ , SOP.SListI columns

270+ , SOP.SListI constraints )

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

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

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

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

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

276+ -> ByteString

277+renderCreation tab columns constraints = renderSQL tab

278+ <+> parenthesized

279+ ( renderCommaSeparated renderColumnDef columns

280+ <> ( case constraints of

281+ Nil -> ""

282+ _ -> ", " <>

283+ renderCommaSeparated renderConstraint constraints ) )

284+ <> ";"

285+ where

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

287+ renderColumnDef (ty `As` column) =

288+ renderSQL column <+> renderColumnTypeExpression ty

289+ renderConstraint

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

291+ -> ByteString

292+ renderConstraint (constraint `As` alias) =

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

294+

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

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

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

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

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

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

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

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

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

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

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

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

307+newtype TableConstraintExpression

308+ (sch :: Symbol)

309+ (tab :: Symbol)

310+ (schemas :: SchemasType)

311+ (constraint :: TableConstraint)

312+ = UnsafeTableConstraintExpression

313+ { renderTableConstraintExpression :: ByteString }

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

315+instance RenderSQL

316+ (TableConstraintExpression sch tab schemas constraint) where

317+ renderSQL = renderTableConstraintExpression

318+

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

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

321+a Boolean (truth-value) expression.

322+

323+>>> :{

324+type Schema = '[

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

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

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

328+ ])]

329+:}

330+

331+>>> :{

332+let

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

334+ definition = createTable #tab

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

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

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

338+:}

339+

340+>>> printSQL definition

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

342+-}

343+check

344+ :: ( Has sch schemas schema

345+ , Has tab schema ('Table table)

346+ , HasAll aliases (TableToRow table) subcolumns )

347+ => NP Alias aliases

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

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

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

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

352+check _cols condition = UnsafeTableConstraintExpression $

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

354+

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

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

357+

358+>>> :{

359+type Schema = '[

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

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

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

363+ ])]

364+:}

365+

366+>>> :{

367+let

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

369+ definition = createTable #tab

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

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

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

373+:}

374+

375+>>> printSQL definition

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

377+-}

378+unique

379+ :: ( Has sch schemas schema

380+ , Has tab schema('Table table)

381+ , HasAll aliases (TableToRow table) subcolumns )

382+ => NP Alias aliases

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

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

385+unique columns = UnsafeTableConstraintExpression $

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

387+

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

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

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

391+

392+>>> :{

393+type Schema = '[

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

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

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

397+ ])]

398+:}

399+

400+>>> :{

401+let

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

403+ definition = createTable #tab

404+ ( serial `as` #id :*

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

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

407+:}

408+

409+>>> printSQL definition

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

411+-}

412+primaryKey

413+ :: ( Has sch schemas schema

414+ , Has tab schema ('Table table)

415+ , HasAll aliases (TableToColumns table) subcolumns

416+ , AllNotNull subcolumns )

417+ => NP Alias aliases

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

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

420+primaryKey columns = UnsafeTableConstraintExpression $

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

422+

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

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

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

426+between two related tables.

427+

428+>>> :{

429+type Schema =

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

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

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

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

434+ ])

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

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

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

438+ ] :=>

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

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

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

442+ ])

443+ ]

444+:}

445+

446+>>> :{

447+let

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

449+ setup =

450+ createTable #users

451+ ( serial `as` #id :*

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

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

454+ createTable #emails

455+ ( serial `as` #id :*

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

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

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

459+ foreignKey #user_id #users #id

460+ OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

461+in printSQL setup

462+:}

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

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

465+

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

467+

468+>>> :{

469+type Schema =

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

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

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

473+ ] :=>

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

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

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

477+ ])

478+ ]

479+:}

480+

481+>>> :{

482+let

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

484+ setup =

485+ createTable #employees

486+ ( serial `as` #id :*

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

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

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

490+ foreignKey #employer_id #employees #id

491+ OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )

492+in printSQL setup

493+:}

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

495+-}

496+foreignKey

497+ :: (ForeignKeyed schemas sch schema child parent

498+ table reftable

499+ columns refcolumns

500+ constraints cols

501+ reftys tys )

502+ => NP Alias columns

503+ -- ^ column or columns in the table

504+ -> Alias parent

505+ -- ^ reference table

506+ -> NP Alias refcolumns

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

508+ -> OnDeleteClause

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

510+ -> OnUpdateClause

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

512+ -> TableConstraintExpression sch child schemas

513+ ('ForeignKey columns parent refcolumns)

514+foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $

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

516+ <+> "REFERENCES" <+> renderSQL parent

517+ <+> parenthesized (renderSQL refs)

518+ <+> renderSQL ondel

519+ <+> renderSQL onupd

520+

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

522+type ForeignKeyed schemas

523+ sch

524+ schema

525+ child parent

526+ table reftable

527+ columns refcolumns

528+ constraints cols

529+ reftys tys =

530+ ( Has sch schemas schema

531+ , Has child schema ('Table table)

532+ , Has parent schema ('Table reftable)

533+ , HasAll columns (TableToColumns table) tys

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

535+ , HasAll refcolumns cols reftys

536+ , SOP.AllZip SamePGType tys reftys

537+ , Uniquely refcolumns constraints )

538+

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

540+data OnDeleteClause

541+ = OnDeleteNoAction

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

543+ -- an error is raised

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

545+ | OnDeleteCascade

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

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

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

549+instance NFData OnDeleteClause

550+-- | Render `OnDeleteClause`.

551+instance RenderSQL OnDeleteClause where

552+ renderSQL = \case

553+ OnDeleteNoAction -> "ON DELETE NO ACTION"

554+ OnDeleteRestrict -> "ON DELETE RESTRICT"

555+ OnDeleteCascade -> "ON DELETE CASCADE"

556+

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

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

559+data OnUpdateClause

560+ = OnUpdateNoAction

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

562+ -- an error is raised

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

564+ | OnUpdateCascade

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

566+ -- into the referencing row(s)

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

568+instance NFData OnUpdateClause

569+

570+-- | Render `OnUpdateClause`.

571+instance RenderSQL OnUpdateClause where

572+ renderSQL = \case

573+ OnUpdateNoAction -> "ON UPDATE NO ACTION"

574+ OnUpdateRestrict -> "ON UPDATE RESTRICT"

575+ OnUpdateCascade -> "ON UPDATE CASCADE"

576+

577+{-----------------------------------------

578+DROP statements

579+-----------------------------------------}

580+

581+-- | >>> :{

582+-- let

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

584+-- definition = dropSchema #muh_schema

585+-- :}

586+--

587+-- >>> printSQL definition

588+-- DROP SCHEMA "muh_schema";

589+dropSchema

590+ :: Has sch schemas schema

591+ => Alias sch

592+ -- ^ user defined schema

593+ -> Definition schemas (Drop sch schemas)

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

595+

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

597+--

598+-- >>> :{

599+-- let

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

601+-- definition = dropTable #muh_table

602+-- :}

603+--

604+-- >>> printSQL definition

605+-- DROP TABLE "muh_table";

606+dropTable

607+ :: ( Has sch schemas schema

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

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

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

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

612+

613+{-----------------------------------------

614+ALTER statements

615+-----------------------------------------}

616+

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

618+alterTable

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

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

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

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

623+alterTable tab alteration = UnsafeDefinition $

624+ "ALTER TABLE"

625+ <+> renderSQL tab

626+ <+> renderAlterTable alteration

627+ <> ";"

628+

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

630+--

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

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

633+alterTableRename

634+ :: (KnownSymbol table0, KnownSymbol table1)

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

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

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

638+alterTableRename table0 table1 = UnsafeDefinition $

639+ "ALTER TABLE" <+> renderSQL table0

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

641+

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

643+-- of a table.

644+newtype AlterTable

645+ (sch :: Symbol)

646+ (tab :: Symbol)

647+ (schemas :: SchemasType)

648+ (table :: TableType) =

649+ UnsafeAlterTable {renderAlterTable :: ByteString}

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

651+

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

653+--

654+-- >>> :{

655+-- let

656+-- definition :: Definition

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

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

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

660+-- in printSQL definition

661+-- :}

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

663+addConstraint

664+ :: ( KnownSymbol alias

665+ , Has sch schemas schema

666+ , Has tab schema ('Table table0)

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

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

669+ => Alias alias

670+ -> TableConstraintExpression sch tab schemas constraint

671+ -- ^ constraint to add

672+ -> AlterTable sch tab schemas table1

673+addConstraint alias constraint = UnsafeAlterTable $

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

675+ <+> renderSQL constraint

676+

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

678+--

679+-- >>> :{

680+-- let

681+-- definition :: Definition

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

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

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

685+-- in printSQL definition

686+-- :}

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

688+dropConstraint

689+ :: ( KnownSymbol constraint

690+ , Has sch schemas schema

691+ , Has tab schema ('Table table0)

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

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

694+ => Alias constraint

695+ -- ^ constraint to drop

696+ -> AlterTable sch tab schemas table1

697+dropConstraint constraint = UnsafeAlterTable $

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

699+

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

701+class AddColumn ty where

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

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

704+ --

705+ -- >>> :{

706+ -- let

707+ -- definition :: Definition

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

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

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

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

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

713+ -- in printSQL definition

714+ -- :}

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

716+ --

717+ -- >>> :{

718+ -- let

719+ -- definition :: Definition

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

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

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

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

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

725+ -- in printSQL definition

726+ -- :}

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

728+ addColumn

729+ :: ( KnownSymbol column

730+ , Has sch schemas schema

731+ , Has tab schema ('Table table0)

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

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

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

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

736+ addColumn column ty = UnsafeAlterTable $

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

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

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

740+

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

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

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

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

745+--

746+-- >>> :{

747+-- let

748+-- definition :: Definition

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

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

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

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

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

754+-- in printSQL definition

755+-- :}

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

757+dropColumn

758+ :: ( KnownSymbol column

759+ , Has sch schemas schema

760+ , Has tab schema ('Table table0)

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

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

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

764+ -> AlterTable sch tab schemas table1

765+dropColumn column = UnsafeAlterTable $

766+ "DROP COLUMN" <+> renderSQL column

767+

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

769+--

770+-- >>> :{

771+-- let

772+-- definition :: Definition

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

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

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

776+-- in printSQL definition

777+-- :}

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

779+renameColumn

780+ :: ( KnownSymbol column0

781+ , KnownSymbol column1

782+ , Has sch schemas schema

783+ , Has tab schema ('Table table0)

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

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

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

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

788+ -> AlterTable sch tab schemas table1

789+renameColumn column0 column1 = UnsafeAlterTable $

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

791+

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

793+alterColumn

794+ :: ( KnownSymbol column

795+ , Has sch schemas schema

796+ , Has tab schema ('Table table0)

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

798+ , Has column columns ty0

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

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

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

802+ -> AlterTable sch tab schemas table1

803+alterColumn column alteration = UnsafeAlterTable $

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

805+

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

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

808+ UnsafeAlterColumn {renderAlterColumn :: ByteString}

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

810+

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

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

813+-- future insert and update commands.

814+--

815+-- >>> :{

816+-- let

817+-- definition :: Definition

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

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

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

821+-- in printSQL definition

822+-- :}

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

824+setDefault

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

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

827+setDefault expression = UnsafeAlterColumn $

828+ "SET DEFAULT" <+> renderExpression expression

829+

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

831+--

832+-- >>> :{

833+-- let

834+-- definition :: Definition

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

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

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

838+-- in printSQL definition

839+-- :}

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

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

842+dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"

843+

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

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

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

847+--

848+-- >>> :{

849+-- let

850+-- definition :: Definition

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

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

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

854+-- in printSQL definition

855+-- :}

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

857+setNotNull

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

859+setNotNull = UnsafeAlterColumn $ "SET NOT NULL"

860+

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

862+--

863+-- >>> :{

864+-- let

865+-- definition :: Definition

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

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

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

869+-- in printSQL definition

870+-- :}

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

872+dropNotNull

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

874+dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"

875+

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

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

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

879+--

880+-- >>> :{

881+-- let

882+-- definition :: Definition

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

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

885+-- definition =

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

887+-- in printSQL definition

888+-- :}

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

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

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

892+

893+{- | Create a view.

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

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

896+>>> :{

897+let

898+ definition :: Definition

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

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

901+ definition =

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

903+in printSQL definition

904+:}

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

906+-}

907+createView

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

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

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

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

912+createView alias query = UnsafeDefinition $

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

914+ <+> renderQuery query <> ";"

915+

916+-- | Drop a view.

917+--

918+-- >>> :{

919+-- let

920+-- definition :: Definition

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

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

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

924+-- definition = dropView #bc

925+-- in printSQL definition

926+-- :}

927+-- DROP VIEW "bc";

928+dropView

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

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

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

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

933+

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

935+--

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

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

938+createTypeEnum

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

940+ => QualifiedAlias sch enum

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

942+ -> NP PGlabel labels

943+ -- ^ labels of the enumerated type

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

945+createTypeEnum enum labels = UnsafeDefinition $

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

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

948+

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

950+--

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

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

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

954+-- >>> :{

955+-- let

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

957+-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma

958+-- in

959+-- printSQL createSchwarma

960+-- :}

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

962+createTypeEnumFrom

963+ :: forall hask sch enum schemas schema.

964+ ( SOP.Generic hask

965+ , SOP.All KnownSymbol (LabelsPG hask)

966+ , KnownSymbol enum

967+ , Has sch schemas schema )

968+ => QualifiedAlias sch enum

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

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

971+createTypeEnumFrom enum = createTypeEnum enum

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

973+

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

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

976+

977+>>> :{

978+type PGcomplex = 'PGcomposite

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

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

981+:}

982+

983+>>> :{

984+let

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

986+ setup = createTypeComposite #complex

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

988+in printSQL setup

989+:}

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

991+-}

992+createTypeComposite

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

994+ => QualifiedAlias sch ty

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

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

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

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

999+createTypeComposite ty fields = UnsafeDefinition $

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

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

1002+ where

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

1004+ renderField (typ `As` alias) =

1005+ renderSQL alias <+> renderSQL typ

1006+

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

1008+--

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

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

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

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

1013+-- >>> :{

1014+-- let

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

1016+-- createComplex = createTypeCompositeFrom @Complex #complex

1017+-- in

1018+-- printSQL createComplex

1019+-- :}

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

1021+createTypeCompositeFrom

1022+ :: forall hask sch ty schemas schema.

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

1024+ , KnownSymbol ty

1025+ , Has sch schemas schema )

1026+ => QualifiedAlias sch ty

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

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

1029+createTypeCompositeFrom ty = createTypeComposite ty

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

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

1032+

1033+{-|

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

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

1036+

1037+Domains are useful for abstracting common constraints on fields

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

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

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

1041+each table's constraint individually.

1042+

1043+>>> :{

1044+let

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

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

1047+in printSQL createPositive

1048+:}

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

1050+-}

1051+createDomain

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

1053+ => QualifiedAlias sch dom

1054+ -> (forall null. TypeExpression schemas (null ty))

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

1056+ -> Definition schemas (Alter sch (Create dom ('Typedef ty) schema) schemas)

1057+createDomain dom ty condition =

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

1059+ <+> "AS" <+> renderTypeExpression ty

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

1061+

1062+{- |

1063+>>> :{

1064+let

1065+ createSmallIntRange :: Definition (Public '[]) (Public '["int2range" ::: 'Typedef ('PGrange 'PGint2)])

1066+ createSmallIntRange = createTypeRange #int2range int2

1067+in printSQL createSmallIntRange

1068+:}

1069+CREATE TYPE "int2range" AS RANGE (subtype = int2);

1070+-}

1071+createTypeRange

1072+ :: (Has sch schemas schema, KnownSymbol range)

1073+ => QualifiedAlias sch range

1074+ -> (forall null. TypeExpression schemas (null ty))

1075+ -> Definition schemas (Alter sch (Create range ('Typedef ('PGrange ty)) schema) schemas)

1076+createTypeRange range ty = UnsafeDefinition $

1077+ "CREATE" <+> "TYPE" <+> renderSQL range <+> "AS" <+> "RANGE" <+>

1078+ parenthesized ("subtype" <+> "=" <+> renderTypeExpression ty) <> ";"

1079+

1080+{- |

1081+>>> :{

1082+type Table = '[] :=>

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

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

1085+:}

1086+

1087+>>> :{

1088+let

1089+ setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table, "ix" ::: 'Index])

1090+ setup =

1091+ createTable #tab (nullable int `as` #a :* nullable real `as` #b) Nil >>>

1092+ createIndex #ix #tab Btree [#a & AscNullsFirst, #b & AscNullsLast]

1093+in printSQL setup

1094+:}

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

1096+CREATE INDEX "ix" ON "tab" USING btree (("a") ASC NULLS FIRST, ("b") ASC NULLS LAST);

1097+-}

1098+createIndex

1099+ :: (Has sch schemas schema, Has tab schema ('Table table), KnownSymbol ix)

1100+ => Alias ix

1101+ -> QualifiedAlias sch tab

1102+ -> IndexMethod

1103+ -> [SortExpression '[] '[] 'Ungrouped schemas '[] '[tab ::: TableToRow table]]

1104+ -> Definition schemas (Alter sch (Create ix 'Index schema) schemas)

1105+createIndex ix tab method cols = UnsafeDefinition $

1106+ "CREATE" <+> "INDEX" <+> renderSQL ix <+> "ON" <+> renderSQL tab

1107+ <+> "USING" <+> renderSQL method

1108+ <+> parenthesized (commaSeparated (renderIndex <$> cols))

1109+ <> ";"

1110+ where

1111+ renderIndex = \case

1112+ Asc expression -> parenthesized (renderSQL expression) <+> "ASC"

1113+ Desc expression -> parenthesized (renderSQL expression) <+> "DESC"

1114+ AscNullsFirst expression -> parenthesized (renderSQL expression)

1115+ <+> "ASC NULLS FIRST"

1116+ DescNullsFirst expression -> parenthesized (renderSQL expression)

1117+ <+> "DESC NULLS FIRST"

1118+ AscNullsLast expression -> parenthesized (renderSQL expression)

1119+ <+> "ASC NULLS LAST"

1120+ DescNullsLast expression -> parenthesized (renderSQL expression)

1121+ <+> "DESC NULLS LAST"

1122+

1123+data IndexMethod

1124+ = Btree

1125+ | Hash

1126+ | Gist

1127+ | Spgist

1128+ | Gin

1129+ | Brin

1130+ deriving stock (Eq, Ord, Show, GHC.Generic)

1131+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

1132+instance RenderSQL IndexMethod where

1133+ renderSQL = \case

1134+ Btree -> "btree"

1135+ Hash -> "hash"

1136+ Gist -> "gist"

1137+ Spgist -> "spgist"

1138+ Gin -> "gin"

1139+ Brin -> "brin"

1140+

1141+createFunction

1142+ :: ( Has sch schemas schema

1143+ , KnownSymbol fun

1144+ , SOP.SListI args )

1145+ => QualifiedAlias sch fun

1146+ -> NP (TypeExpression schemas) args

1147+ -> TypeExpression schemas ret

1148+ -> FunctionDefinition schemas args ('Returns ret)

1149+ -> Definition schemas (Alter sch (Create fun ('Function args ('Returns ret)) schema) schemas)

1150+createFunction fun args ret fundef = UnsafeDefinition $

1151+ "CREATE" <+> "FUNCTION" <+> renderSQL fun

1152+ <+> parenthesized (renderCommaSeparated renderSQL args)

1153+ <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"

1154+

1155+createOrReplaceFunction

1156+ :: ( Has sch schemas schema

1157+ , Has fun schema ('Function args0 ret0)

1158+ , SOP.SListI args )

1159+ => QualifiedAlias sch fun

1160+ -> NP (TypeExpression schemas) args

1161+ -> TypeExpression schemas ret

1162+ -> FunctionDefinition schemas args ('Returns ret)

1163+ -> Definition schemas (Alter sch (Alter fun ('Function args ('Returns ret)) schema) schemas)

1164+createOrReplaceFunction fun args ret fundef = UnsafeDefinition $

1165+ "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun

1166+ <+> parenthesized (renderCommaSeparated renderSQL args)

1167+ <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"

1168+

1169+languageSqlExpr

1170+ :: Expression '[] '[] 'Ungrouped schemas args '[] ret

1171+ -> FunctionDefinition schemas args ('Returns ret)

1172+languageSqlExpr expr = UnsafeFunctionDefinition $

1173+ "language sql as"

1174+ <+> "$$" <+> renderSQL (values_ (expr `as` #ret)) <+> "$$"

1175+

1176+languageSqlQuery

1177+ :: Query '[] '[] schemas args rets

1178+ -> FunctionDefinition schemas args ('ReturnsTable rets)

1179+languageSqlQuery qry = UnsafeFunctionDefinition $

1180+ "language sql as" <+> "$$" <+> renderSQL qry <+> "$$"

1181+

1182+createSetFunction

1183+ :: ( Has sch schemas schema

1184+ , KnownSymbol fun

1185+ , SOP.SListI args

1186+ , SOP.SListI rets )

1187+ => QualifiedAlias sch fun

1188+ -> NP (TypeExpression schemas) args

1189+ -> NP (Aliased (TypeExpression schemas)) rets

1190+ -> FunctionDefinition schemas args ('ReturnsTable rets)

1191+ -> Definition schemas (Alter sch (Create fun ('Function args ('ReturnsTable rets)) schema) schemas)

1192+createSetFunction fun args rets fundef = UnsafeDefinition $

1193+ "CREATE" <+> "FUNCTION" <+> renderSQL fun

1194+ <+> parenthesized (renderCommaSeparated renderSQL args)

1195+ <+> "RETURNS" <+> "TABLE"

1196+ <+> parenthesized (renderCommaSeparated renderRet rets)

1197+ <+> renderSQL fundef <> ";"

1198+ where

1199+ renderRet :: Aliased (TypeExpression s) r -> ByteString

1200+ renderRet (ty `As` col) = renderSQL col <+> renderSQL ty

1201+

1202+createOrReplaceSetFunction

1203+ :: ( Has sch schemas schema

1204+ , Has fun schema ('Function args0 ret0)

1205+ , SOP.SListI args

1206+ , SOP.SListI rets )

1207+ => QualifiedAlias sch fun

1208+ -> NP (TypeExpression schemas) args

1209+ -> NP (Aliased (TypeExpression schemas)) rets

1210+ -> FunctionDefinition schemas args ('ReturnsTable rets)

1211+ -> Definition schemas (Alter sch (Alter fun ('Function args ('ReturnsTable rets)) schema) schemas)

1212+createOrReplaceSetFunction fun args rets fundef = UnsafeDefinition $

1213+ "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun

1214+ <+> parenthesized (renderCommaSeparated renderSQL args)

1215+ <+> "RETURNS" <+> "TABLE"

1216+ <+> parenthesized (renderCommaSeparated renderRet rets)

1217+ <+> renderSQL fundef <> ";"

1218+ where

1219+ renderRet :: Aliased (TypeExpression s) r -> ByteString

1220+ renderRet (ty `As` col) = renderSQL col <+> renderSQL ty

1221+

1222+createBinaryOp

1223+ :: forall op fun sch schemas schema x y z.

1224+ ( Has sch schemas schema

1225+ , Has fun schema ('Function '[x,y] ('Returns z))

1226+ , KnownSymbol op )

1227+ => Alias fun

1228+ -> TypeExpression schemas x

1229+ -> TypeExpression schemas y

1230+ -> Definition schemas

1231+ (Alter sch (Create op ('Operator ('BinaryOp x y z)) schema) schemas)

1232+createBinaryOp fun x y = UnsafeDefinition $

1233+ "CREATE" <+> "OPERATOR" <+> renderSymbol @op

1234+ <+> parenthesized (commaSeparated opdef)

1235+ where

1236+ opdef =

1237+ [ "FUNCTION" <+> "=" <+> renderSQL fun

1238+ , "LEFTARG" <+> "=" <+> renderSQL x

1239+ , "RIGHTARG" <+> "=" <+> renderSQL y ]

1240+

1241+createLeftOp

1242+ :: forall op fun sch schemas schema x y.

1243+ ( Has sch schemas schema

1244+ , Has fun schema ('Function '[x] ('Returns y))

1245+ , KnownSymbol op )

1246+ => Alias fun

1247+ -> TypeExpression schemas x

1248+ -> Definition schemas

1249+ (Alter sch (Create op ('Operator ('LeftOp x y)) schema) schemas)

1250+createLeftOp fun x = UnsafeDefinition $

1251+ "CREATE" <+> "OPERATOR" <+> renderSymbol @op

1252+ <+> parenthesized (commaSeparated opdef)

1253+ where

1254+ opdef =

1255+ [ "FUNCTION" <+> "=" <+> renderSQL fun

1256+ , "RIGHTARG" <+> "=" <+> renderSQL x ]

1257+

1258+createRightOp

1259+ :: forall op fun sch schemas schema x y.

1260+ ( Has sch schemas schema

1261+ , Has fun schema ('Function '[x] ('Returns y))

1262+ , KnownSymbol op )

1263+ => Alias fun

1264+ -> TypeExpression schemas x

1265+ -> Definition schemas

1266+ (Alter sch (Create op ('Operator ('RightOp x y)) schema) schemas)

1267+createRightOp fun x = UnsafeDefinition $

1268+ "CREATE" <+> "OPERATOR" <+> renderSymbol @op

1269+ <+> parenthesized (commaSeparated opdef)

1270+ where

1271+ opdef =

1272+ [ "FUNCTION" <+> "=" <+> renderSQL fun

1273+ , "LEFTARG" <+> "=" <+> renderSQL x ]

1274+

1275+dropFunction

1276+ :: (Has sch schemas schema, Has fun schema ('Function args ret))

1277+ => QualifiedAlias sch fun

1278+ -- ^ name of the user defined function

1279+ -> Definition schemas (Alter sch (Drop fun schema) schemas)

1280+dropFunction fun = UnsafeDefinition $

1281+ "DROP" <+> "FUNCTION" <+> renderSQL fun <> ";"

1282+

1283+dropOperator

1284+ :: (Has sch schemas schema, Has op schema ('Operator oper))

1285+ => QualifiedAlias sch op

1286+ -- ^ name of the user defined operator

1287+ -> Definition schemas (Alter sch (Drop op schema) schemas)

1288+dropOperator op = UnsafeDefinition $

1289+ "DROP" <+> "OPERATOR" <+> renderSQL op <> ";"

1290+

1291+newtype FunctionDefinition schemas args ret = UnsafeFunctionDefinition

1292+ { renderFunctionDefinition :: ByteString }

1293+ deriving (Eq,Show,GHC.Generic,NFData)

1294+instance RenderSQL (FunctionDefinition schemas args ret) where

1295+ renderSQL = renderFunctionDefinition

1296+

1297+-- |

1298+-- >>> printSQL (dropIndex #ix :: Definition (Public '["ix" ::: 'Index]) (Public '[]))

1299+-- DROP INDEX "ix";

1300+dropIndex

1301+ :: (Has sch schemas schema, Has ix schema 'Index)

1302+ => QualifiedAlias sch ix

1303+ -- ^ name of the user defined index

1304+ -> Definition schemas (Alter sch (Drop ix schema) schemas)

1305+dropIndex ix = UnsafeDefinition $ "DROP" <+> "INDEX" <+> renderSQL ix <> ";"

1306+

1307+-- | Lift `PGTyped` to a field

1308+class FieldTyped schemas ty where

1309+ fieldtype :: Aliased (TypeExpression schemas) ty

1310+instance (KnownSymbol alias, PGTyped schemas ty)

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

1312+ fieldtype = pgtype `As` Alias

1313+

1314+-- | Drop a type.

1315+--

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

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

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

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

1320+-- DROP TYPE "schwarma";

1321+dropType

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

1323+ => QualifiedAlias sch td

1324+ -- ^ name of the user defined type

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

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

1327+

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

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

1330+ = UnsafeColumnTypeExpression { renderColumnTypeExpression :: ByteString }

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

1332+instance RenderSQL (ColumnTypeExpression schemas ty) where

1333+ renderSQL = renderColumnTypeExpression

1334+

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

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

1337+nullable

1338+ :: TypeExpression schemas (nullity ty)

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

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

1341+

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

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

1344+notNullable

1345+ :: TypeExpression schemas (nullity ty)

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

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

1348+

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

1350+default_

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

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

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

1354+default_ x ty = UnsafeColumnTypeExpression $

1355+ renderSQL ty <+> "DEFAULT" <+> renderExpression x

1356+

1357+-- | not a true type, but merely a notational convenience for creating

1358+-- unique identifier columns with type `PGint2`

1359+serial2, smallserial

1360+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint2)

1361+serial2 = UnsafeColumnTypeExpression "serial2"

1362+smallserial = UnsafeColumnTypeExpression "smallserial"

1363+-- | not a true type, but merely a notational convenience for creating

1364+-- unique identifier columns with type `PGint4`

1365+serial4, serial

1366+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint4)

1367+serial4 = UnsafeColumnTypeExpression "serial4"

1368+serial = UnsafeColumnTypeExpression "serial"

1369+-- | not a true type, but merely a notational convenience for creating

1370+-- unique identifier columns with type `PGint8`

1371+serial8, bigserial

1372+ :: ColumnTypeExpression schemas ('Def :=> 'NotNull 'PGint8)

1373+serial8 = UnsafeColumnTypeExpression "serial8"

1374+bigserial = UnsafeColumnTypeExpression "bigserial"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Function.hsdeleted−238

@@ -1,238 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Function

3−Description: Create and drop function and operator definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop function and operator definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Function

33− ( createFunction

34− , createOrReplaceFunction

35− , createSetFunction

36− , createOrReplaceSetFunction

37− , createBinaryOp

38− , createLeftOp

39− , createRightOp

40− , dropFunction

41− , dropFunctionIfExists

42− , dropOperator

43− , dropOperatorIfExists

44− , FunctionDefinition(..)

45− , languageSqlExpr

46− , languageSqlQuery

47− ) where

48−

49−import Control.DeepSeq

50−import Data.ByteString

51−import GHC.TypeLits

52−

53−import qualified Generics.SOP as SOP

54−import qualified GHC.Generics as GHC

55−

56−import Squeal.PostgreSQL.Alias

57−import Squeal.PostgreSQL.Definition

58−import Squeal.PostgreSQL.Expression

59−import Squeal.PostgreSQL.Expression.Type

60−import Squeal.PostgreSQL.List

61−import Squeal.PostgreSQL.Query

62−import Squeal.PostgreSQL.Render

63−import Squeal.PostgreSQL.Schema

64−

65−-- $setup

66−-- >>> import Squeal.PostgreSQL

67−

68−createFunction

69− :: ( Has sch schemas schema

70− , KnownSymbol fun

71− , SOP.SListI args )

72− => QualifiedAlias sch fun

73− -> NP (TypeExpression schemas) args

74− -> TypeExpression schemas ret

75− -> FunctionDefinition schemas args ('Returns ret)

76− -> Definition schemas (Alter sch (Create fun ('Function (args :=> 'Returns ret)) schema) schemas)

77−createFunction fun args ret fundef = UnsafeDefinition $

78− "CREATE" <+> "FUNCTION" <+> renderSQL fun

79− <+> parenthesized (renderCommaSeparated renderSQL args)

80− <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"

81−

82−createOrReplaceFunction

83− :: ( Has sch schemas schema

84− , KnownSymbol fun

85− , SOP.SListI args )

86− => QualifiedAlias sch fun

87− -> NP (TypeExpression schemas) args

88− -> TypeExpression schemas ret

89− -> FunctionDefinition schemas args ('Returns ret)

90− -> Definition schemas (Alter sch (CreateOrReplace fun ('Function (args :=> 'Returns ret)) schema) schemas)

91−createOrReplaceFunction fun args ret fundef = UnsafeDefinition $

92− "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun

93− <+> parenthesized (renderCommaSeparated renderSQL args)

94− <+> "RETURNS" <+> renderSQL ret <+> renderSQL fundef <> ";"

95−

96−languageSqlExpr

97− :: Expression '[] '[] 'Ungrouped schemas args '[] ret

98− -> FunctionDefinition schemas args ('Returns ret)

99−languageSqlExpr expr = UnsafeFunctionDefinition $

100− "language sql as"

101− <+> "$$" <+> renderSQL (values_ (expr `as` #ret)) <+> "$$"

102−

103−languageSqlQuery

104− :: Query '[] '[] schemas args rets

105− -> FunctionDefinition schemas args ('ReturnsTable rets)

106−languageSqlQuery qry = UnsafeFunctionDefinition $

107− "language sql as" <+> "$$" <+> renderSQL qry <+> "$$"

108−

109−createSetFunction

110− :: ( Has sch schemas schema

111− , KnownSymbol fun

112− , SOP.SListI args

113− , SOP.SListI rets )

114− => QualifiedAlias sch fun

115− -> NP (TypeExpression schemas) args

116− -> NP (Aliased (TypeExpression schemas)) rets

117− -> FunctionDefinition schemas args ('ReturnsTable rets)

118− -> Definition schemas (Alter sch (Create fun ('Function (args :=> 'ReturnsTable rets)) schema) schemas)

119−createSetFunction fun args rets fundef = UnsafeDefinition $

120− "CREATE" <+> "FUNCTION" <+> renderSQL fun

121− <+> parenthesized (renderCommaSeparated renderSQL args)

122− <+> "RETURNS" <+> "TABLE"

123− <+> parenthesized (renderCommaSeparated renderRet rets)

124− <+> renderSQL fundef <> ";"

125− where

126− renderRet :: Aliased (TypeExpression s) r -> ByteString

127− renderRet (ty `As` col) = renderSQL col <+> renderSQL ty

128−

129−createOrReplaceSetFunction

130− :: ( Has sch schemas schema

131− , KnownSymbol fun

132− , SOP.SListI args

133− , SOP.SListI rets )

134− => QualifiedAlias sch fun

135− -> NP (TypeExpression schemas) args

136− -> NP (Aliased (TypeExpression schemas)) rets

137− -> FunctionDefinition schemas args ('ReturnsTable rets)

138− -> Definition schemas (Alter sch (CreateOrReplace fun ('Function (args :=> 'ReturnsTable rets)) schema) schemas)

139−createOrReplaceSetFunction fun args rets fundef = UnsafeDefinition $

140− "CREATE" <+> "OR" <+> "REPLACE" <+> "FUNCTION" <+> renderSQL fun

141− <+> parenthesized (renderCommaSeparated renderSQL args)

142− <+> "RETURNS" <+> "TABLE"

143− <+> parenthesized (renderCommaSeparated renderRet rets)

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

145− where

146− renderRet :: Aliased (TypeExpression s) r -> ByteString

147− renderRet (ty `As` col) = renderSQL col <+> renderSQL ty

148−

149−createBinaryOp

150− :: forall op fun sch schemas schema x y z.

151− ( Has sch schemas schema

152− , Has fun schema ('Function ('[x,y] :=> 'Returns z))

153− , KnownSymbol op )

154− => QualifiedAlias sch fun

155− -> TypeExpression schemas x

156− -> TypeExpression schemas y

157− -> Definition schemas

158− (Alter sch (Create op ('Operator ('BinaryOp x y z)) schema) schemas)

159−createBinaryOp fun x y = UnsafeDefinition $

160− "CREATE" <+> "OPERATOR" <+> renderSymbol @op

161− <+> parenthesized (commaSeparated opdef)

162− where

163− opdef =

164− [ "FUNCTION" <+> "=" <+> renderSQL fun

165− , "LEFTARG" <+> "=" <+> renderSQL x

166− , "RIGHTARG" <+> "=" <+> renderSQL y ]

167−

168−createLeftOp

169− :: forall op fun sch schemas schema x y.

170− ( Has sch schemas schema

171− , Has fun schema ('Function ('[x] :=> 'Returns y))

172− , KnownSymbol op )

173− => QualifiedAlias sch fun

174− -> TypeExpression schemas x

175− -> Definition schemas

176− (Alter sch (Create op ('Operator ('LeftOp x y)) schema) schemas)

177−createLeftOp fun x = UnsafeDefinition $

178− "CREATE" <+> "OPERATOR" <+> renderSymbol @op

179− <+> parenthesized (commaSeparated opdef)

180− where

181− opdef =

182− [ "FUNCTION" <+> "=" <+> renderSQL fun

183− , "RIGHTARG" <+> "=" <+> renderSQL x ]

184−

185−createRightOp

186− :: forall op fun sch schemas schema x y.

187− ( Has sch schemas schema

188− , Has fun schema ('Function ('[x] :=> 'Returns y))

189− , KnownSymbol op )

190− => QualifiedAlias sch fun

191− -> TypeExpression schemas x

192− -> Definition schemas

193− (Alter sch (Create op ('Operator ('RightOp x y)) schema) schemas)

194−createRightOp fun x = UnsafeDefinition $

195− "CREATE" <+> "OPERATOR" <+> renderSymbol @op

196− <+> parenthesized (commaSeparated opdef)

197− where

198− opdef =

199− [ "FUNCTION" <+> "=" <+> renderSQL fun

200− , "LEFTARG" <+> "=" <+> renderSQL x ]

201−

202−dropFunction

203− :: (Has sch schemas schema, KnownSymbol fun)

204− => QualifiedAlias sch fun

205− -- ^ name of the user defined function

206− -> Definition schemas (Alter sch (DropSchemum fun 'Function schema) schemas)

207−dropFunction fun = UnsafeDefinition $

208− "DROP" <+> "FUNCTION" <+> renderSQL fun <> ";"

209−

210−dropFunctionIfExists

211− :: (Has sch schemas schema, KnownSymbol fun)

212− => QualifiedAlias sch fun

213− -- ^ name of the user defined function

214− -> Definition schemas (Alter sch (DropSchemumIfExists fun 'Function schema) schemas)

215−dropFunctionIfExists fun = UnsafeDefinition $

216− "DROP FUNCTION IF EXISTS" <+> renderSQL fun <> ";"

217−

218−dropOperator

219− :: (Has sch schemas schema, KnownSymbol op)

220− => QualifiedAlias sch op

221− -- ^ name of the user defined operator

222− -> Definition schemas (Alter sch (DropSchemum op 'Operator schema) schemas)

223−dropOperator op = UnsafeDefinition $

224− "DROP" <+> "OPERATOR" <+> renderSQL op <> ";"

225−

226−dropOperatorIfExists

227− :: (Has sch schemas schema, KnownSymbol op)

228− => QualifiedAlias sch op

229− -- ^ name of the user defined operator

230− -> Definition schemas (Alter sch (DropSchemumIfExists op 'Operator schema) schemas)

231−dropOperatorIfExists op = UnsafeDefinition $

232− "DROP OPERATOR IF EXISTS" <+> renderSQL op <> ";"

233−

234−newtype FunctionDefinition schemas args ret = UnsafeFunctionDefinition

235− { renderFunctionDefinition :: ByteString }

236− deriving (Eq,Show,GHC.Generic,NFData)

237−instance RenderSQL (FunctionDefinition schemas args ret) where

238− renderSQL = renderFunctionDefinition

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Index.hsdeleted−159

@@ -1,159 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Index

3−Description: Create and drop index definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop index definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Index

33− ( createIndex

34− , createIndexIfNotExists

35− , dropIndex

36− , dropIndexIfExists

37− , IndexMethod (..)

38− , btree

39− , hash

40− , gist

41− , spgist

42− , gin

43− , brin

44− ) where

45−

46−import Data.ByteString

47−import GHC.TypeLits

48−

49−import qualified GHC.Generics as GHC

50−

51−import Squeal.PostgreSQL.Alias

52−import Squeal.PostgreSQL.Definition

53−import Squeal.PostgreSQL.Expression.Sort

54−import Squeal.PostgreSQL.Render

55−import Squeal.PostgreSQL.Schema

56−

57−-- $setup

58−-- >>> import Squeal.PostgreSQL

59−

60−{- |

61−>>> :{

62−type Table = '[] :=>

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

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

65−:}

66−

67−>>> :{

68−let

69− setup :: Definition (Public '[]) (Public '["tab" ::: 'Table Table, "ix" ::: 'Index 'Btree])

70− setup =

71− createTable #tab (nullable int `as` #a :* nullable real `as` #b) Nil >>>

72− createIndex #ix #tab btree [#a & AscNullsFirst, #b & AscNullsLast]

73−in printSQL setup

74−:}

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

76−CREATE INDEX "ix" ON "tab" USING btree (("a") ASC NULLS FIRST, ("b") ASC NULLS LAST);

77−-}

78−createIndex

79− :: (Has sch schemas schema, Has tab schema ('Table table), KnownSymbol ix)

80− => Alias ix

81− -> QualifiedAlias sch tab

82− -> IndexMethod method

83− -> [SortExpression '[] '[] 'Ungrouped schemas '[] '[tab ::: TableToRow table]]

84− -> Definition schemas (Alter sch (Create ix ('Index method) schema) schemas)

85−createIndex ix tab method cols = UnsafeDefinition $

86− "CREATE" <+> "INDEX" <+> renderSQL ix <+> "ON" <+> renderSQL tab

87− <+> "USING" <+> renderSQL method

88− <+> parenthesized (commaSeparated (renderIndex <$> cols))

89− <> ";"

90− where

91− renderIndex = \case

92− Asc expression -> parenthesized (renderSQL expression) <+> "ASC"

93− Desc expression -> parenthesized (renderSQL expression) <+> "DESC"

94− AscNullsFirst expression -> parenthesized (renderSQL expression)

95− <+> "ASC NULLS FIRST"

96− DescNullsFirst expression -> parenthesized (renderSQL expression)

97− <+> "DESC NULLS FIRST"

98− AscNullsLast expression -> parenthesized (renderSQL expression)

99− <+> "ASC NULLS LAST"

100− DescNullsLast expression -> parenthesized (renderSQL expression)

101− <+> "DESC NULLS LAST"

102−

103−createIndexIfNotExists

104− :: (Has sch schemas schema, Has tab schema ('Table table), KnownSymbol ix)

105− => Alias ix

106− -> QualifiedAlias sch tab

107− -> IndexMethod method

108− -> [SortExpression '[] '[] 'Ungrouped schemas '[] '[tab ::: TableToRow table]]

109− -> Definition schemas (Alter sch (CreateIfNotExists ix ('Index method) schema) schemas)

110−createIndexIfNotExists ix tab method cols = UnsafeDefinition $

111− "CREATE INDEX IF NOT EXISTS" <+> renderSQL ix <+> "ON" <+> renderSQL tab

112− <+> "USING" <+> renderSQL method

113− <+> parenthesized (commaSeparated (renderIndex <$> cols))

114− <> ";"

115− where

116− renderIndex = \case

117− Asc expression -> parenthesized (renderSQL expression) <+> "ASC"

118− Desc expression -> parenthesized (renderSQL expression) <+> "DESC"

119− AscNullsFirst expression -> parenthesized (renderSQL expression)

120− <+> "ASC NULLS FIRST"

121− DescNullsFirst expression -> parenthesized (renderSQL expression)

122− <+> "DESC NULLS FIRST"

123− AscNullsLast expression -> parenthesized (renderSQL expression)

124− <+> "ASC NULLS LAST"

125− DescNullsLast expression -> parenthesized (renderSQL expression)

126− <+> "DESC NULLS LAST"

127−

128−newtype IndexMethod ty = UnsafeIndexMethod {renderIndexMethod :: ByteString}

129− deriving stock (Eq, Ord, Show, GHC.Generic)

130−instance RenderSQL (IndexMethod ty) where renderSQL = renderIndexMethod

131−btree :: IndexMethod 'Btree

132−btree = UnsafeIndexMethod "btree"

133−hash :: IndexMethod 'Hash

134−hash = UnsafeIndexMethod "hash"

135−gist :: IndexMethod 'Gist

136−gist = UnsafeIndexMethod "gist"

137−spgist :: IndexMethod 'Spgist

138−spgist = UnsafeIndexMethod "spgist"

139−gin :: IndexMethod 'Gin

140−gin = UnsafeIndexMethod "gin"

141−brin :: IndexMethod 'Brin

142−brin = UnsafeIndexMethod "brin"

143−

144−-- |

145−-- >>> printSQL (dropIndex #ix :: Definition (Public '["ix" ::: 'Index 'Btree]) (Public '[]))

146−-- DROP INDEX "ix";

147−dropIndex

148− :: (Has sch schemas schema, KnownSymbol ix)

149− => QualifiedAlias sch ix

150− -- ^ name of the user defined index

151− -> Definition schemas (Alter sch (DropSchemum ix 'Index schema) schemas)

152−dropIndex ix = UnsafeDefinition $ "DROP" <+> "INDEX" <+> renderSQL ix <> ";"

153−

154−dropIndexIfExists

155− :: (Has sch schemas schema, KnownSymbol ix)

156− => QualifiedAlias sch ix

157− -- ^ name of the user defined index

158− -> Definition schemas (Alter sch (DropSchemumIfExists ix 'Index schema) schemas)

159−dropIndexIfExists ix = UnsafeDefinition $ "DROP INDEX IF EXISTS" <+> renderSQL ix <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Schema.hsdeleted−96

@@ -1,96 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Schema

3−Description: Create and drop schema definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop schema definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Schema

33− ( createSchema

34− , createSchemaIfNotExists

35− , dropSchema

36− , dropSchemaIfExists

37− ) where

38−

39−import GHC.TypeLits

40−

41−import Squeal.PostgreSQL.Alias

42−import Squeal.PostgreSQL.Definition

43−import Squeal.PostgreSQL.Render

44−import Squeal.PostgreSQL.Schema

45−

46−-- $setup

47−-- >>> import Squeal.PostgreSQL

48−

49−{- |

50−`createSchema` enters a new schema into the current database.

51−The schema name must be distinct from the name of any existing schema

52−in the current database.

53−

54−A schema is essentially a namespace: it contains named objects

55−(tables, data types, functions, and operators) whose names

56−can duplicate those of other objects existing in other schemas.

57−Named objects are accessed by `QualifiedAlias`es with the schema

58−name as a prefix.

59−-}

60−createSchema

61− :: KnownSymbol sch

62− => Alias sch

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

64−createSchema sch = UnsafeDefinition $

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

66−

67−{- | Idempotent version of `createSchema`. -}

68−createSchemaIfNotExists

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

70− => Alias sch

71− -> Definition schemas (CreateIfNotExists sch '[] schemas)

72−createSchemaIfNotExists sch = UnsafeDefinition $

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

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

75−

76−-- | >>> :{

77−-- let

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

79−-- definition = dropSchema #muh_schema

80−-- :}

81−--

82−-- >>> printSQL definition

83−-- DROP SCHEMA "muh_schema";

84−dropSchema

85− :: KnownSymbol sch

86− => Alias sch

87− -- ^ user defined schema

88− -> Definition schemas (Drop sch schemas)

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

90−

91−dropSchemaIfExists

92− :: KnownSymbol sch

93− => Alias sch

94− -- ^ user defined schema

95− -> Definition schemas (DropIfExists sch schemas)

96−dropSchemaIfExists sch = UnsafeDefinition $ "DROP SCHEMA" <+> renderSQL sch <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table.hsdeleted−500

@@ -1,500 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Table

3−Description: Create, drop and alter table definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create, drop and alter table definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Table

33− ( createTable

34− , createTableIfNotExists

35− , dropTable

36− , dropTableIfExists

37− , alterTable

38− , alterTableIfExists

39− , alterTableRename

40− , alterTableIfExistsRename

41− , AlterTable (..)

42− , addConstraint

43− , dropConstraint

44− , AddColumn (..)

45− , dropColumn

46− , renameColumn

47− , alterColumn

48− , AlterColumn (..)

49− , setDefault

50− , dropDefault

51− , setNotNull

52− , dropNotNull

53− , alterType

54− ) where

55−

56−import Control.DeepSeq

57−import Data.ByteString

58−import GHC.TypeLits

59−

60−import qualified Generics.SOP as SOP

61−import qualified GHC.Generics as GHC

62−

63−import Squeal.PostgreSQL.Alias

64−import Squeal.PostgreSQL.Definition

65−import Squeal.PostgreSQL.Definition.Table.Constraint

66−import Squeal.PostgreSQL.Expression

67−import Squeal.PostgreSQL.Expression.Type

68−import Squeal.PostgreSQL.List

69−import Squeal.PostgreSQL.Render

70−import Squeal.PostgreSQL.Schema

71−

72−-- $setup

73−-- >>> import Squeal.PostgreSQL

74−

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

76−

77−>>> :set -XOverloadedLabels

78−>>> :{

79−type Table = '[] :=>

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

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

82−:}

83−

84−>>> :{

85−let

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

87− setup = createTable #tab

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

89−in printSQL setup

90−:}

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

92−-}

93−createTable

94− :: ( KnownSymbol sch

95− , KnownSymbol tab

96− , columns ~ (col ': cols)

97− , SOP.SListI columns

98− , SOP.SListI constraints

99− , Has sch schemas0 schema0

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

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

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

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

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

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

106− -> Definition schemas0 schemas1

107−createTable tab columns constraints = UnsafeDefinition $

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

109−

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

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

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

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

114−

115−>>> :set -XOverloadedLabels -XTypeApplications

116−>>> :{

117−type Table = '[] :=>

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

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

120−:}

121−

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

123−

124−>>> :{

125−let

126− setup :: Definition Schemas Schemas

127− setup = createTableIfNotExists #tab

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

129−in printSQL setup

130−:}

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

132−-}

133−createTableIfNotExists

134− :: ( KnownSymbol sch

135− , KnownSymbol tab

136− , columns ~ (col ': cols)

137− , SOP.SListI columns

138− , SOP.SListI constraints

139− , Has sch schemas0 schema0

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

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

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

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

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

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

146− -> Definition schemas0 schemas1

147−createTableIfNotExists tab columns constraints = UnsafeDefinition $

148− "CREATE TABLE IF NOT EXISTS"

149− <+> renderCreation tab columns constraints

150−

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

152−renderCreation

153− :: ( KnownSymbol sch

154− , KnownSymbol tab

155− , SOP.SListI columns

156− , SOP.SListI constraints )

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

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

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

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

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

162− -> ByteString

163−renderCreation tab columns constraints = renderSQL tab

164− <+> parenthesized

165− ( renderCommaSeparated renderColumnDef columns

166− <> ( case constraints of

167− Nil -> ""

168− _ -> ", " <>

169− renderCommaSeparated renderConstraint constraints ) )

170− <> ";"

171− where

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

173− renderColumnDef (ty `As` column) =

174− renderSQL column <+> renderColumnTypeExpression ty

175− renderConstraint

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

177− -> ByteString

178− renderConstraint (constraint `As` alias) =

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

180−

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

182−--

183−-- >>> :{

184−-- let

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

186−-- definition = dropTable #muh_table

187−-- :}

188−--

189−-- >>> printSQL definition

190−-- DROP TABLE "muh_table";

191−dropTable

192− :: ( Has sch schemas schema

193− , KnownSymbol tab )

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

195− -> Definition schemas (Alter sch (DropSchemum tab 'Table schema) schemas)

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

197−

198−dropTableIfExists

199− :: ( Has sch schemas schema

200− , KnownSymbol tab)

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

202− -> Definition schemas (Alter sch (DropSchemumIfExists tab 'Table schema) schemas)

203−dropTableIfExists tab = UnsafeDefinition $ "DROP TABLE IF EXISTS" <+> renderSQL tab <> ";"

204−

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

206−alterTable

207− :: (Has sch schemas schema, KnownSymbol tab)

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

209− -> AlterTable sch tab schemas table -- ^ alteration to perform

210− -> Definition schemas (Alter sch (Alter tab ('Table table) schema) schemas)

211−alterTable tab alteration = UnsafeDefinition $

212− "ALTER TABLE"

213− <+> renderSQL tab

214− <+> renderAlterTable alteration

215− <> ";"

216−

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

218−alterTableIfExists

219− :: (Has sch schemas schema, KnownSymbol tab)

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

221− -> AlterTable sch tab schemas table -- ^ alteration to perform

222− -> Definition schemas (Alter sch (AlterIfExists tab ('Table table) schema) schemas)

223−alterTableIfExists tab alteration = UnsafeDefinition $

224− "ALTER TABLE IF EXISTS"

225− <+> renderSQL tab

226− <+> renderAlterTable alteration

227− <> ";"

228−

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

230−--

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

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

233−alterTableRename

234− :: (KnownSymbol tab0, KnownSymbol tab1)

235− => Alias tab0 -- ^ table to rename

236− -> Alias tab1 -- ^ what to rename it

237− -> Definition schema (Rename tab0 tab1 schema)

238−alterTableRename tab0 tab1 = UnsafeDefinition $

239− "ALTER TABLE" <+> renderSQL tab0

240− <+> "RENAME TO" <+> renderSQL tab1 <> ";"

241−

242−alterTableIfExistsRename

243− :: (KnownSymbol tab0, KnownSymbol tab1)

244− => Alias tab0 -- ^ table to rename

245− -> Alias tab1 -- ^ what to rename it

246− -> Definition schema (RenameIfExists tab0 tab1 schema)

247−alterTableIfExistsRename tab0 tab1 = UnsafeDefinition $

248− "ALTER TABLE IF EXISTS" <+> renderSQL tab0

249− <+> "RENAME TO" <+> renderSQL tab1 <> ";"

250−

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

252−-- of a table.

253−newtype AlterTable

254− (sch :: Symbol)

255− (tab :: Symbol)

256− (schemas :: SchemasType)

257− (table :: TableType) =

258− UnsafeAlterTable {renderAlterTable :: ByteString}

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

260−

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

262−--

263−-- >>> :{

264−-- let

265−-- definition :: Definition

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

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

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

269−-- in printSQL definition

270−-- :}

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

272−addConstraint

273− :: ( KnownSymbol alias

274− , Has sch schemas schema

275− , Has tab schema ('Table table0)

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

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

278− => Alias alias

279− -> TableConstraintExpression sch tab schemas constraint

280− -- ^ constraint to add

281− -> AlterTable sch tab schemas table1

282−addConstraint alias constraint = UnsafeAlterTable $

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

284− <+> renderSQL constraint

285−

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

287−--

288−-- >>> :{

289−-- let

290−-- definition :: Definition

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

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

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

294−-- in printSQL definition

295−-- :}

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

297−dropConstraint

298− :: ( KnownSymbol constraint

299− , Has sch schemas schema

300− , Has tab schema ('Table table0)

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

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

303− => Alias constraint

304− -- ^ constraint to drop

305− -> AlterTable sch tab schemas table1

306−dropConstraint constraint = UnsafeAlterTable $

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

308−

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

310−class AddColumn ty where

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

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

313− --

314− -- >>> :{

315− -- let

316− -- definition :: Definition

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

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

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

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

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

322− -- in printSQL definition

323− -- :}

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

325− --

326− -- >>> :{

327− -- let

328− -- definition :: Definition

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

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

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

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

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

334− -- in printSQL definition

335− -- :}

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

337− addColumn

338− :: ( KnownSymbol column

339− , Has sch schemas schema

340− , Has tab schema ('Table table0)

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

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

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

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

345− addColumn column ty = UnsafeAlterTable $

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

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

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

349−

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

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

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

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

354−--

355−-- >>> :{

356−-- let

357−-- definition :: Definition

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

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

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

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

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

363−-- in printSQL definition

364−-- :}

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

366−dropColumn

367− :: ( KnownSymbol column

368− , Has sch schemas schema

369− , Has tab schema ('Table table0)

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

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

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

373− -> AlterTable sch tab schemas table1

374−dropColumn column = UnsafeAlterTable $

375− "DROP COLUMN" <+> renderSQL column

376−

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

378−--

379−-- >>> :{

380−-- let

381−-- definition :: Definition

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

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

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

385−-- in printSQL definition

386−-- :}

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

388−renameColumn

389− :: ( KnownSymbol column0

390− , KnownSymbol column1

391− , Has sch schemas schema

392− , Has tab schema ('Table table0)

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

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

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

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

397− -> AlterTable sch tab schemas table1

398−renameColumn column0 column1 = UnsafeAlterTable $

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

400−

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

402−alterColumn

403− :: ( KnownSymbol column

404− , Has sch schemas schema

405− , Has tab schema ('Table table0)

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

407− , Has column columns ty0

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

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

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

411− -> AlterTable sch tab schemas table1

412−alterColumn column alteration = UnsafeAlterTable $

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

414−

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

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

417− UnsafeAlterColumn {renderAlterColumn :: ByteString}

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

419−

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

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

422−-- future insert and update commands.

423−--

424−-- >>> :{

425−-- let

426−-- definition :: Definition

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

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

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

430−-- in printSQL definition

431−-- :}

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

433−setDefault

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

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

436−setDefault expression = UnsafeAlterColumn $

437− "SET DEFAULT" <+> renderExpression expression

438−

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

440−--

441−-- >>> :{

442−-- let

443−-- definition :: Definition

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

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

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

447−-- in printSQL definition

448−-- :}

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

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

451−dropDefault = UnsafeAlterColumn $ "DROP DEFAULT"

452−

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

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

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

456−--

457−-- >>> :{

458−-- let

459−-- definition :: Definition

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

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

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

463−-- in printSQL definition

464−-- :}

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

466−setNotNull

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

468−setNotNull = UnsafeAlterColumn $ "SET NOT NULL"

469−

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

471−--

472−-- >>> :{

473−-- let

474−-- definition :: Definition

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

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

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

478−-- in printSQL definition

479−-- :}

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

481−dropNotNull

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

483−dropNotNull = UnsafeAlterColumn $ "DROP NOT NULL"

484−

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

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

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

488−--

489−-- >>> :{

490−-- let

491−-- definition :: Definition

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

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

494−-- definition =

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

496−-- in printSQL definition

497−-- :}

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

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

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

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Table/Constraint.hsdeleted−339

@@ -1,339 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Table.Constraint

3−Description: Table constraint expressions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Table constraint expressions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Table.Constraint

33− ( TableConstraintExpression (..)

34− , check

35− , unique

36− , primaryKey

37− , foreignKey

38− , ForeignKeyed

39− , OnDeleteClause (..)

40− , OnUpdateClause (..)

41− ) where

42−

43−import Control.DeepSeq

44−import Data.ByteString

45−import GHC.TypeLits

46−

47−import qualified Generics.SOP as SOP

48−import qualified GHC.Generics as GHC

49−

50−import Squeal.PostgreSQL.Alias

51−import Squeal.PostgreSQL.Expression.Logic

52−import Squeal.PostgreSQL.List

53−import Squeal.PostgreSQL.Render

54−import Squeal.PostgreSQL.Schema

55−

56−-- $setup

57−-- >>> import Squeal.PostgreSQL

58−

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

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

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

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

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

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

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

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

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

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

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

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

71−newtype TableConstraintExpression

72− (sch :: Symbol)

73− (tab :: Symbol)

74− (schemas :: SchemasType)

75− (constraint :: TableConstraint)

76− = UnsafeTableConstraintExpression

77− { renderTableConstraintExpression :: ByteString }

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

79−instance RenderSQL

80− (TableConstraintExpression sch tab schemas constraint) where

81− renderSQL = renderTableConstraintExpression

82−

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

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

85−a Boolean (truth-value) expression.

86−

87−>>> :{

88−type Schema = '[

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

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

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

92− ])]

93−:}

94−

95−>>> :{

96−let

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

98− definition = createTable #tab

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

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

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

102−:}

103−

104−>>> printSQL definition

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

106−-}

107−check

108− :: ( Has sch schemas schema

109− , Has tab schema ('Table table)

110− , HasAll aliases (TableToRow table) subcolumns )

111− => NP Alias aliases

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

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

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

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

116−check _cols condition = UnsafeTableConstraintExpression $

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

118−

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

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

121−

122−>>> :{

123−type Schema = '[

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

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

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

127− ])]

128−:}

129−

130−>>> :{

131−let

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

133− definition = createTable #tab

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

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

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

137−:}

138−

139−>>> printSQL definition

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

141−-}

142−unique

143− :: ( Has sch schemas schema

144− , Has tab schema('Table table)

145− , HasAll aliases (TableToRow table) subcolumns )

146− => NP Alias aliases

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

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

149−unique columns = UnsafeTableConstraintExpression $

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

151−

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

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

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

155−

156−>>> :{

157−type Schema = '[

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

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

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

161− ])]

162−:}

163−

164−>>> :{

165−let

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

167− definition = createTable #tab

168− ( serial `as` #id :*

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

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

171−:}

172−

173−>>> printSQL definition

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

175−-}

176−primaryKey

177− :: ( Has sch schemas schema

178− , Has tab schema ('Table table)

179− , HasAll aliases (TableToColumns table) subcolumns

180− , AllNotNull subcolumns )

181− => NP Alias aliases

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

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

184−primaryKey columns = UnsafeTableConstraintExpression $

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

186−

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

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

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

190−between two related tables.

191−

192−>>> :{

193−type Schema =

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

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

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

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

198− ])

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

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

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

202− ] :=>

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

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

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

206− ])

207− ]

208−:}

209−

210−>>> :{

211−let

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

213− setup =

214− createTable #users

215− ( serial `as` #id :*

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

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

218− createTable #emails

219− ( serial `as` #id :*

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

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

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

223− foreignKey #user_id #users #id

224− OnDeleteCascade OnUpdateCascade `as` #fk_user_id )

225−in printSQL setup

226−:}

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

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

229−

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

231−

232−>>> :{

233−type Schema =

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

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

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

237− ] :=>

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

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

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

241− ])

242− ]

243−:}

244−

245−>>> :{

246−let

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

248− setup =

249− createTable #employees

250− ( serial `as` #id :*

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

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

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

254− foreignKey #employer_id #employees #id

255− OnDeleteCascade OnUpdateCascade `as` #employees_employer_fk )

256−in printSQL setup

257−:}

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

259−-}

260−foreignKey

261− :: (ForeignKeyed schemas sch schema child parent

262− table reftable

263− columns refcolumns

264− constraints cols

265− reftys tys )

266− => NP Alias columns

267− -- ^ column or columns in the table

268− -> Alias parent

269− -- ^ reference table

270− -> NP Alias refcolumns

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

272− -> OnDeleteClause

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

274− -> OnUpdateClause

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

276− -> TableConstraintExpression sch child schemas

277− ('ForeignKey columns parent refcolumns)

278−foreignKey keys parent refs ondel onupd = UnsafeTableConstraintExpression $

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

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

281− <+> parenthesized (renderSQL refs)

282− <+> renderSQL ondel

283− <+> renderSQL onupd

284−

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

286−type ForeignKeyed schemas

287− sch

288− schema

289− child parent

290− table reftable

291− columns refcolumns

292− constraints cols

293− reftys tys =

294− ( Has sch schemas schema

295− , Has child schema ('Table table)

296− , Has parent schema ('Table reftable)

297− , HasAll columns (TableToColumns table) tys

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

299− , HasAll refcolumns cols reftys

300− , SOP.AllZip SamePGType tys reftys

301− , Uniquely refcolumns constraints )

302−

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

304−data OnDeleteClause

305− = OnDeleteNoAction

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

307− -- an error is raised

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

309− | OnDeleteCascade

310− -- ^ specifies that when a referenced row is deleted,

311− -- row(s) referencing it should be automatically deleted as well

312− deriving (GHC.Generic,Show,Eq,Ord)

313−instance NFData OnDeleteClause

314−-- | Render `OnDeleteClause`.

315−instance RenderSQL OnDeleteClause where

316− renderSQL = \case

317− OnDeleteNoAction -> "ON DELETE NO ACTION"

318− OnDeleteRestrict -> "ON DELETE RESTRICT"

319− OnDeleteCascade -> "ON DELETE CASCADE"

320−

321−-- | Analagous to `OnDeleteClause` there is also `OnUpdateClause` which is invoked

322−-- when a referenced column is changed (updated).

323−data OnUpdateClause

324− = OnUpdateNoAction

325− -- ^ if any referencing rows has not changed when the constraint is checked,

326− -- an error is raised

327− | OnUpdateRestrict -- ^ prevents update of a referenced row

328− | OnUpdateCascade

329− -- ^ the updated values of the referenced column(s) should be copied

330− -- into the referencing row(s)

331− deriving (GHC.Generic,Show,Eq,Ord)

332−instance NFData OnUpdateClause

333−

334−-- | Render `OnUpdateClause`.

335−instance RenderSQL OnUpdateClause where

336− renderSQL = \case

337− OnUpdateNoAction -> "ON UPDATE NO ACTION"

338− OnUpdateRestrict -> "ON UPDATE RESTRICT"

339− OnUpdateCascade -> "ON UPDATE CASCADE"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/Type.hsdeleted−229

@@ -1,229 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.Type

3−Description: Create and drop type definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop type definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.Type

33− ( createTypeEnum

34− , createTypeEnumFrom

35− , createTypeComposite

36− , createTypeCompositeFrom

37− , createTypeRange

38− , createDomain

39− , dropType

40− , dropTypeIfExists

41− ) where

42−

43−import Data.ByteString

44−import Data.Monoid

45−import GHC.TypeLits

46−import Prelude hiding ((.), id)

47−

48−import qualified Generics.SOP as SOP

49−

50−import Squeal.PostgreSQL.Alias

51−import Squeal.PostgreSQL.Expression.Logic

52−import Squeal.PostgreSQL.Expression.Type

53−import Squeal.PostgreSQL.Definition

54−import Squeal.PostgreSQL.List

55−import Squeal.PostgreSQL.PG

56−import Squeal.PostgreSQL.Render

57−import Squeal.PostgreSQL.Schema

58−

59−-- $setup

60−-- >>> import Squeal.PostgreSQL

61−-- >>> import qualified GHC.Generics as GHC

62−-- >>> import qualified Generics.SOP as SOP

63−

64−-- | Enumerated types are created using the `createTypeEnum` command, for example

65−--

66−-- >>> printSQL $ (createTypeEnum #mood (label @"sad" :* label @"ok" :* label @"happy") :: Definition (Public '[]) '["public" ::: '["mood" ::: 'Typedef ('PGenum '["sad","ok","happy"])]])

67−-- CREATE TYPE "mood" AS ENUM ('sad', 'ok', 'happy');

68−createTypeEnum

69− :: (KnownSymbol enum, Has sch schemas schema, SOP.All KnownSymbol labels)

70− => QualifiedAlias sch enum

71− -- ^ name of the user defined enumerated type

72− -> NP PGlabel labels

73− -- ^ labels of the enumerated type

74− -> Definition schemas (Alter sch (Create enum ('Typedef ('PGenum labels)) schema) schemas)

75−createTypeEnum enum labels = UnsafeDefinition $

76− "CREATE" <+> "TYPE" <+> renderSQL enum <+> "AS" <+> "ENUM" <+>

77− parenthesized (renderSQL labels) <> ";"

78−

79−-- | Enumerated types can also be generated from a Haskell type, for example

80−--

81−-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

82−-- >>> instance SOP.Generic Schwarma

83−-- >>> instance SOP.HasDatatypeInfo Schwarma

84−-- >>> :{

85−-- let

86−-- createSchwarma :: Definition (Public '[]) '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]]

87−-- createSchwarma = createTypeEnumFrom @Schwarma #schwarma

88−-- in

89−-- printSQL createSchwarma

90−-- :}

91−-- CREATE TYPE "schwarma" AS ENUM ('Beef', 'Lamb', 'Chicken');

92−createTypeEnumFrom

93− :: forall hask sch enum schemas schema.

94− ( SOP.Generic hask

95− , SOP.All KnownSymbol (LabelsPG hask)

96− , KnownSymbol enum

97− , Has sch schemas schema )

98− => QualifiedAlias sch enum

99− -- ^ name of the user defined enumerated type

100− -> Definition schemas (Alter sch (Create enum ('Typedef (PG (Enumerated hask))) schema) schemas)

101−createTypeEnumFrom enum = createTypeEnum enum

102− (SOP.hpure label :: NP PGlabel (LabelsPG hask))

103−

104−{- | `createTypeComposite` creates a composite type. The composite type is

105−specified by a list of attribute names and data types.

106−

107−>>> :{

108−type PGcomplex = 'PGcomposite

109− '[ "real" ::: 'NotNull 'PGfloat8

110− , "imaginary" ::: 'NotNull 'PGfloat8 ]

111−:}

112−

113−>>> :{

114−let

115− setup :: Definition (Public '[]) '["public" ::: '["complex" ::: 'Typedef PGcomplex]]

116− setup = createTypeComposite #complex

117− (float8 `as` #real :* float8 `as` #imaginary)

118−in printSQL setup

119−:}

120−CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

121−-}

122−createTypeComposite

123− :: (KnownSymbol ty, Has sch schemas schema, SOP.SListI fields)

124− => QualifiedAlias sch ty

125− -- ^ name of the user defined composite type

126− -> NP (Aliased (TypeExpression schemas)) fields

127− -- ^ list of attribute names and data types

128− -> Definition schemas (Alter sch (Create ty ('Typedef ('PGcomposite fields)) schema) schemas)

129−createTypeComposite ty fields = UnsafeDefinition $

130− "CREATE" <+> "TYPE" <+> renderSQL ty <+> "AS" <+> parenthesized

131− (renderCommaSeparated renderField fields) <> ";"

132− where

133− renderField :: Aliased (TypeExpression schemas) x -> ByteString

134− renderField (typ `As` alias) =

135− renderSQL alias <+> renderSQL typ

136−

137−-- | Composite types can also be generated from a Haskell type, for example

138−--

139−-- >>> data Complex = Complex {real :: Double, imaginary :: Double} deriving GHC.Generic

140−-- >>> instance SOP.Generic Complex

141−-- >>> instance SOP.HasDatatypeInfo Complex

142−-- >>> type Schema = '["complex" ::: 'Typedef (PG (Composite Complex))]

143−-- >>> :{

144−-- let

145−-- createComplex :: Definition (Public '[]) (Public Schema)

146−-- createComplex = createTypeCompositeFrom @Complex #complex

147−-- in

148−-- printSQL createComplex

149−-- :}

150−-- CREATE TYPE "complex" AS ("real" float8, "imaginary" float8);

151−createTypeCompositeFrom

152− :: forall hask sch ty schemas schema.

153− ( SOP.All (FieldTyped schemas) (RowPG hask)

154− , KnownSymbol ty

155− , Has sch schemas schema )

156− => QualifiedAlias sch ty

157− -- ^ name of the user defined composite type

158− -> Definition schemas (Alter sch (Create ty ( 'Typedef (PG (Composite hask))) schema) schemas)

159−createTypeCompositeFrom ty = createTypeComposite ty

160− (SOP.hcpure (SOP.Proxy :: SOP.Proxy (FieldTyped schemas)) fieldtype

161− :: NP (Aliased (TypeExpression schemas)) (RowPG hask))

162−

163−{-|

164−`createDomain` creates a new domain. A domain is essentially a data type

165−with constraints (restrictions on the allowed set of values).

166−

167−Domains are useful for abstracting common constraints on fields

168−into a single location for maintenance. For example, several tables might

169−contain email address columns, all requiring the same `check` constraint

170−to verify the address syntax. Define a domain rather than setting up

171−each table's constraint individually.

172−

173−>>> :{

174−let

175− createPositive :: Definition (Public '[]) (Public '["positive" ::: 'Typedef 'PGfloat4])

176− createPositive = createDomain #positive real (#value .> 0 .&& (#value & isNotNull))

177−in printSQL createPositive

178−:}

179−CREATE DOMAIN "positive" AS real CHECK ((("value" > 0) AND "value" IS NOT NULL));

180−-}

181−createDomain

182− :: (Has sch schemas schema, KnownSymbol dom)

183− => QualifiedAlias sch dom

184− -> (forall null. TypeExpression schemas (null ty))

185− -> (forall tab. Condition '[] '[] 'Ungrouped schemas '[] '[tab ::: '["value" ::: 'Null ty]])

186− -> Definition schemas (Alter sch (Create dom ('Typedef ty) schema) schemas)

187−createDomain dom ty condition =

188− UnsafeDefinition $ "CREATE DOMAIN" <+> renderSQL dom

189− <+> "AS" <+> renderTypeExpression ty

190− <+> "CHECK" <+> parenthesized (renderSQL condition) <> ";"

191−

192−{- |

193−>>> :{

194−let

195− createSmallIntRange :: Definition (Public '[]) (Public '["int2range" ::: 'Typedef ('PGrange 'PGint2)])

196− createSmallIntRange = createTypeRange #int2range int2

197−in printSQL createSmallIntRange

198−:}

199−CREATE TYPE "int2range" AS RANGE (subtype = int2);

200−-}

201−createTypeRange

202− :: (Has sch schemas schema, KnownSymbol range)

203− => QualifiedAlias sch range

204− -> (forall null. TypeExpression schemas (null ty))

205− -> Definition schemas (Alter sch (Create range ('Typedef ('PGrange ty)) schema) schemas)

206−createTypeRange range ty = UnsafeDefinition $

207− "CREATE" <+> "TYPE" <+> renderSQL range <+> "AS" <+> "RANGE" <+>

208− parenthesized ("subtype" <+> "=" <+> renderTypeExpression ty) <> ";"

209−

210−-- | Drop a type.

211−--

212−-- >>> data Schwarma = Beef | Lamb | Chicken deriving GHC.Generic

213−-- >>> instance SOP.Generic Schwarma

214−-- >>> instance SOP.HasDatatypeInfo Schwarma

215−-- >>> printSQL (dropType #schwarma :: Definition '["public" ::: '["schwarma" ::: 'Typedef (PG (Enumerated Schwarma))]] (Public '[]))

216−-- DROP TYPE "schwarma";

217−dropType

218− :: (Has sch schemas schema, KnownSymbol td)

219− => QualifiedAlias sch td

220− -- ^ name of the user defined type

221− -> Definition schemas (Alter sch (DropSchemum td 'Typedef schema) schemas)

222−dropType tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

223−

224−dropTypeIfExists

225− :: (Has sch schemas schema, KnownSymbol td)

226− => QualifiedAlias sch td

227− -- ^ name of the user defined type

228− -> Definition schemas (Alter sch (DropSchemumIfExists td 'Typedef schema) schemas)

229−dropTypeIfExists tydef = UnsafeDefinition $ "DROP" <+> "TYPE" <+> renderSQL tydef <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Definition/View.hsdeleted−104

@@ -1,104 +0,0 @@

1−{-|

2−Module: Squeal.PostgreSQL.Definition.View

3−Description: Create and drop view definitions

4−Copyright: (c) Eitan Chatav, 2017

5−Maintainer: eitan@morphism.tech

6−Stability: experimental

7−

8−Create and drop view definitions.

9−-}

10−

11−{-# LANGUAGE

12− AllowAmbiguousTypes

13− , ConstraintKinds

14− , DeriveAnyClass

15− , DeriveGeneric

16− , DerivingStrategies

17− , FlexibleContexts

18− , FlexibleInstances

19− , GADTs

20− , LambdaCase

21− , MultiParamTypeClasses

22− , OverloadedLabels

23− , OverloadedStrings

24− , RankNTypes

25− , ScopedTypeVariables

26− , TypeApplications

27− , TypeInType

28− , TypeOperators

29− , UndecidableSuperClasses

30−#-}

31−

32−module Squeal.PostgreSQL.Definition.View

33− ( createView

34− , createOrReplaceView

35− , dropView

36− , dropViewIfExists

37− ) where

38−

39−import GHC.TypeLits

40−

41−import Squeal.PostgreSQL.Alias

42−import Squeal.PostgreSQL.Definition

43−import Squeal.PostgreSQL.Query

44−import Squeal.PostgreSQL.Render

45−import Squeal.PostgreSQL.Schema

46−

47−-- $setup

48−-- >>> import Squeal.PostgreSQL

49−

50−{- | Create a view.

51−>>> type ABC = '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4]

52−>>> type BC = '["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4]

53−>>> :{

54−let

55− definition :: Definition

56− '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC)]]

57− '[ "public" ::: '["abc" ::: 'Table ('[] :=> ABC), "bc" ::: 'View BC]]

58− definition =

59− createView #bc (select_ (#b :* #c) (from (table #abc)))

60−in printSQL definition

61−:}

62−CREATE VIEW "bc" AS SELECT "b" AS "b", "c" AS "c" FROM "abc" AS "abc";

63−-}

64−createView

65− :: (Has sch schemas schema, KnownSymbol vw)

66− => QualifiedAlias sch vw -- ^ the name of the view to add

67− -> Query '[] '[] schemas '[] view -- ^ query

68− -> Definition schemas (Alter sch (Create vw ('View view) schema) schemas)

69−createView alias query = UnsafeDefinition $

70− "CREATE" <+> "VIEW" <+> renderSQL alias <+> "AS"

71− <+> renderQuery query <> ";"

72−

73−createOrReplaceView

74− :: (Has sch schemas schema, KnownSymbol vw)

75− => QualifiedAlias sch vw -- ^ the name of the view to add

76− -> Query '[] '[] schemas '[] view -- ^ query

77− -> Definition schemas (Alter sch (CreateOrReplace vw ('View view) schema) schemas)

78−createOrReplaceView alias query = UnsafeDefinition $

79− "CREATE OR REPLACE VIEW" <+> renderSQL alias <+> "AS"

80− <+> renderQuery query <> ";"

81−

82−-- | Drop a view.

83−--

84−-- >>> :{

85−-- let

86−-- definition :: Definition

87−-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])

88−-- , "bc" ::: 'View ('["b" ::: 'Null 'PGint4, "c" ::: 'Null 'PGint4])]]

89−-- '[ "public" ::: '["abc" ::: 'Table ('[] :=> '["a" ::: 'NoDef :=> 'Null 'PGint4, "b" ::: 'NoDef :=> 'Null 'PGint4, "c" ::: 'NoDef :=> 'Null 'PGint4])]]

90−-- definition = dropView #bc

91−-- in printSQL definition

92−-- :}

93−-- DROP VIEW "bc";

94−dropView

95− :: (Has sch schemas schema, KnownSymbol vw)

96− => QualifiedAlias sch vw -- ^ view to remove

97− -> Definition schemas (Alter sch (DropSchemum vw 'View schema) schemas)

98−dropView vw = UnsafeDefinition $ "DROP VIEW" <+> renderSQL vw <> ";"

99−

100−dropViewIfExists

101− :: (Has sch schemas schema, KnownSymbol vw)

102− => QualifiedAlias sch vw -- ^ view to remove

103− -> Definition schemas (Alter sch (DropIfExists vw schema) schemas)

104−dropViewIfExists vw = UnsafeDefinition $ "DROP VIEW IF EXISTS" <+> renderSQL vw <> ";"

squeal-postgresql/src/Squeal/PostgreSQL/Expression.hs+10−10

@@ -34,7 +34,7 @@ module Squeal.PostgreSQL.Expression

3434 ( -- * Expression

3535 Expression (..)

3636 , Expr

37− , type (-->)

37+ , (:-->)

3838 , FunctionDB

3939 , unsafeFunction

4040 , function

@@ -48,7 +48,7 @@ module Squeal.PostgreSQL.Expression

4848 , binaryOp

4949 , FunctionVar

5050 , unsafeFunctionVar

51− , type (--->)

51+ , FunctionN

5252 , FunctionNDB

5353 , unsafeFunctionN

5454 , functionN

@@ -159,7 +159,7 @@ type OperatorDB schemas x1 x2 y

159159-- This is a subtype of the usual Haskell function type `Prelude.->`,

160160-- indeed a subcategory as it is closed under the usual

161161-- `Prelude..` and `Prelude.id`.

162−type (-->) x y

162+type (:-->) x y

163163 = forall outer commons grp schemas params from

164164 . Expression outer commons grp schemas params from x

165165 -- ^ input

@@ -179,7 +179,7 @@ Use the `*:` operator to end your argument lists, like so.

179179>>> printSQL (unsafeFunctionN "fun" (true :* false :* localTime *: true))

180180fun(TRUE, FALSE, LOCALTIME, TRUE)

181181-}

182−type (--->) xs y

182+type FunctionN xs y

183183 = forall outer commons grp schemas params from

184184 . NP (Expression outer commons grp schemas params from) xs

185185 -- ^ inputs

@@ -327,7 +327,7 @@ binaryOp = unsafeBinaryOp $ renderSymbol @op

327327

328328-- | >>> printSQL $ unsafeLeftOp "NOT" true

329329-- (NOT TRUE)

330−unsafeLeftOp :: ByteString -> x --> y

330+unsafeLeftOp :: ByteString -> x :--> y

331331unsafeLeftOp op x = UnsafeExpression $ parenthesized $ op <+> renderSQL x

332332

333333leftOp

@@ -339,7 +339,7 @@ leftOp = unsafeLeftOp $ renderSymbol @op

339339

340340-- | >>> printSQL $ true & unsafeRightOp "IS NOT TRUE"

341341-- (TRUE IS NOT TRUE)

342−unsafeRightOp :: ByteString -> x --> y

342+unsafeRightOp :: ByteString -> x :--> y

343343unsafeRightOp op x = UnsafeExpression $ parenthesized $ renderSQL x <+> op

344344

345345rightOp

@@ -351,25 +351,25 @@ rightOp = unsafeRightOp $ renderSymbol @op

351351

352352-- | >>> printSQL $ unsafeFunction "f" true

353353-- f(TRUE)

354−unsafeFunction :: ByteString -> x --> y

354+unsafeFunction :: ByteString -> x :--> y

355355unsafeFunction fun x = UnsafeExpression $

356356 fun <> parenthesized (renderSQL x)

357357

358358function

359− :: (Has sch schemas schema, Has fun schema ('Function ('[x] :=> 'Returns y)))

359+ :: (Has sch schemas schema, Has fun schema ('Function '[x] ('Returns y)))

360360 => QualifiedAlias sch fun

361361 -> FunctionDB schemas x y

362362function = unsafeFunction . renderSQL

363363

364364-- | >>> printSQL $ unsafeFunctionN "f" (currentTime :* localTimestamp :* false *: literal 'a')

365365-- f(CURRENT_TIME, LOCALTIMESTAMP, FALSE, E'a')

366−unsafeFunctionN :: SListI xs => ByteString -> xs ---> y

366+unsafeFunctionN :: SListI xs => ByteString -> FunctionN xs y

367367unsafeFunctionN fun xs = UnsafeExpression $

368368 fun <> parenthesized (renderCommaSeparated renderSQL xs)

369369

370370functionN

371371 :: ( Has sch schemas schema

372− , Has fun schema ('Function (xs :=> 'Returns y))

372+ , Has fun schema ('Function xs ('Returns y))

373373 , SListI xs )

374374 => QualifiedAlias sch fun

375375 -> FunctionNDB schemas xs y

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Collection.hs+5−5

@@ -42,7 +42,7 @@ import qualified Generics.SOP as SOP

4242

4343import Squeal.PostgreSQL.Alias

4444import Squeal.PostgreSQL.Expression

45−import Squeal.PostgreSQL.Expression.Set

45+import Squeal.PostgreSQL.Expression.SetOf

4646import Squeal.PostgreSQL.List

4747import Squeal.PostgreSQL.Render

4848import Squeal.PostgreSQL.Schema

@@ -111,20 +111,20 @@ array2 xss = UnsafeExpression $ "ARRAY" <>

111111

112112-- | >>> printSQL $ cardinality (array [null_, false, true])

113113-- cardinality(ARRAY[NULL, FALSE, TRUE])

114−cardinality :: null ('PGvararray ty) --> null 'PGint8

114+cardinality :: null ('PGvararray ty) :--> null 'PGint8

115115cardinality = unsafeFunction "cardinality"

116116

117117-- | >>> printSQL $ array [null_, false, true] & index 2

118118-- (ARRAY[NULL, FALSE, TRUE])[2]

119119index

120120 :: Word64 -- ^ index

121− -> null ('PGvararray ty) --> NullifyType ty

121+ -> null ('PGvararray ty) :--> NullifyType ty

122122index n expr = UnsafeExpression $

123123 parenthesized (renderSQL expr) <> "[" <> fromString (show n) <> "]"

124124

125125-- | Expand an array to a set of rows

126−unnest :: SetFunction "unnest" (null ('PGvararray ty)) '["unnest" ::: ty]

127−unnest = unsafeSetFunction

126+unnest :: SetOfFunction "unnest" (null ('PGvararray ty)) '["unnest" ::: ty]

127+unnest = unsafeSetOfFunction

128128

129129-- | A row constructor is an expression that builds a row value

130130-- (also called a composite value) using values for its member fields.

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Comparison.hs+6−6

@@ -162,7 +162,7 @@ isNotDistinctFrom = unsafeBinaryOp "IS NOT DISTINCT FROM"

162162>>> printSQL $ true & isTrue

163163(TRUE IS TRUE)

164164-}

165−isTrue :: null0 'PGbool --> null1 'PGbool

165+isTrue :: null0 'PGbool :--> null1 'PGbool

166166isTrue = unsafeRightOp "IS TRUE"

167167

168168{- | is false or unknown

@@ -170,7 +170,7 @@ isTrue = unsafeRightOp "IS TRUE"

170170>>> printSQL $ true & isNotTrue

171171(TRUE IS NOT TRUE)

172172-}

173−isNotTrue :: null0 'PGbool --> null1 'PGbool

173+isNotTrue :: null0 'PGbool :--> null1 'PGbool

174174isNotTrue = unsafeRightOp "IS NOT TRUE"

175175

176176{- | is false

@@ -178,7 +178,7 @@ isNotTrue = unsafeRightOp "IS NOT TRUE"

178178>>> printSQL $ true & isFalse

179179(TRUE IS FALSE)

180180-}

181−isFalse :: null0 'PGbool --> null1 'PGbool

181+isFalse :: null0 'PGbool :--> null1 'PGbool

182182isFalse = unsafeRightOp "IS FALSE"

183183

184184{- | is true or unknown

@@ -186,7 +186,7 @@ isFalse = unsafeRightOp "IS FALSE"

186186>>> printSQL $ true & isNotFalse

187187(TRUE IS NOT FALSE)

188188-}

189−isNotFalse :: null0 'PGbool --> null1 'PGbool

189+isNotFalse :: null0 'PGbool :--> null1 'PGbool

190190isNotFalse = unsafeRightOp "IS NOT FALSE"

191191

192192{- | is unknown

@@ -194,7 +194,7 @@ isNotFalse = unsafeRightOp "IS NOT FALSE"

194194>>> printSQL $ true & isUnknown

195195(TRUE IS UNKNOWN)

196196-}

197−isUnknown :: null0 'PGbool --> null1 'PGbool

197+isUnknown :: null0 'PGbool :--> null1 'PGbool

198198isUnknown = unsafeRightOp "IS UNKNOWN"

199199

200200{- | is true or false

@@ -202,5 +202,5 @@ isUnknown = unsafeRightOp "IS UNKNOWN"

202202>>> printSQL $ true & isNotUnknown

203203(TRUE IS NOT UNKNOWN)

204204-}

205−isNotUnknown :: null0 'PGbool --> null1 'PGbool

205+isNotUnknown :: null0 'PGbool :--> null1 'PGbool

206206isNotUnknown = unsafeRightOp "IS NOT UNKNOWN"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Json.hs+47−40

@@ -81,7 +81,7 @@ import GHC.TypeLits

8181

8282import Squeal.PostgreSQL.Alias

8383import Squeal.PostgreSQL.Expression

84−import Squeal.PostgreSQL.Expression.Set

84+import Squeal.PostgreSQL.Expression.SetOf

8585import Squeal.PostgreSQL.Expression.Type

8686import Squeal.PostgreSQL.List

8787import Squeal.PostgreSQL.Query

@@ -188,7 +188,7 @@ Table 9.45: JSON creation functions

188188-- otherwise, a scalar value is produced. For any scalar type other than a

189189-- number, a Boolean, or a null value, the text representation will be used, in

190190-- such a fashion that it is a valid json value.

191−toJson :: null ty --> null 'PGjson

191+toJson :: null ty :--> null 'PGjson

192192toJson = unsafeFunction "to_json"

193193

194194-- | Returns the value as jsonb. Arrays and composites are converted

@@ -197,26 +197,26 @@ toJson = unsafeFunction "to_json"

197197-- otherwise, a scalar value is produced. For any scalar type other than a

198198-- number, a Boolean, or a null value, the text representation will be used, in

199199-- such a fashion that it is a valid jsonb value.

200−toJsonb :: null ty --> null 'PGjsonb

200+toJsonb :: null ty :--> null 'PGjsonb

201201toJsonb = unsafeFunction "to_jsonb"

202202

203203-- | Returns the array as a JSON array. A PostgreSQL multidimensional array

204204-- becomes a JSON array of arrays.

205−arrayToJson :: null ('PGvararray ty) --> null 'PGjson

205+arrayToJson :: null ('PGvararray ty) :--> null 'PGjson

206206arrayToJson = unsafeFunction "array_to_json"

207207

208208-- | Returns the row as a JSON object.

209−rowToJson :: null ('PGcomposite ty) --> null 'PGjson

209+rowToJson :: null ('PGcomposite ty) :--> null 'PGjson

210210rowToJson = unsafeFunction "row_to_json"

211211

212212-- | Builds a possibly-heterogeneously-typed JSON array out of a variadic

213213-- argument list.

214−jsonBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjson

214+jsonBuildArray :: SOP.SListI tuple => FunctionN tuple (null 'PGjson)

215215jsonBuildArray = unsafeFunctionN "json_build_array"

216216

217217-- | Builds a possibly-heterogeneously-typed (binary) JSON array out of a

218218-- variadic argument list.

219−jsonbBuildArray :: SOP.SListI tuple => tuple ---> null 'PGjsonb

219+jsonbBuildArray :: SOP.SListI tuple => FunctionN tuple (null 'PGjsonb)

220220jsonbBuildArray = unsafeFunctionN "jsonb_build_array"

221221

222222-- | Builds a possibly-heterogeneously-typed JSON object out of a variadic

@@ -224,10 +224,10 @@ jsonbBuildArray = unsafeFunctionN "jsonb_build_array"

224224-- and values.

225225class SOP.SListI tys => JsonBuildObject tys where

226226

227− jsonBuildObject :: tys ---> null 'PGjson

227+ jsonBuildObject :: FunctionN tys (null 'PGjson)

228228 jsonBuildObject = unsafeFunctionN "json_build_object"

229229

230− jsonbBuildObject :: tys ---> null 'PGjsonb

230+ jsonbBuildObject :: FunctionN tys (null 'PGjsonb)

231231 jsonbBuildObject = unsafeFunctionN "jsonb_build_object"

232232

233233instance JsonBuildObject '[]

@@ -240,7 +240,7 @@ instance (JsonBuildObject tys, key `In` PGJsonKey)

240240-- which are taken as a key/value pair.

241241jsonObject

242242 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

243− --> null 'PGjson

243+ :--> null 'PGjson

244244jsonObject = unsafeFunction "json_object"

245245

246246-- | Builds a binary JSON object out of a text array.

@@ -249,24 +249,24 @@ jsonObject = unsafeFunction "json_object"

249249-- which are taken as a key/value pair.

250250jsonbObject

251251 :: null ('PGfixarray '[n,2] ('NotNull 'PGtext))

252− --> null 'PGjsonb

252+ :--> null 'PGjsonb

253253jsonbObject = unsafeFunction "jsonb_object"

254254

255255-- | This is an alternate form of 'jsonObject' that takes two arrays; one for

256256-- keys and one for values, that are zipped pairwise to create a JSON object.

257−jsonZipObject ::

257+jsonZipObject :: FunctionN

258258 '[ null ('PGvararray ('NotNull 'PGtext))

259259 , null ('PGvararray ('NotNull 'PGtext)) ]

260− ---> null 'PGjson

260+ ( null 'PGjson )

261261jsonZipObject = unsafeFunctionN "json_object"

262262

263263-- | This is an alternate form of 'jsonbObject' that takes two arrays; one for

264264-- keys and one for values, that are zipped pairwise to create a binary JSON

265265-- object.

266−jsonbZipObject ::

266+jsonbZipObject :: FunctionN

267267 '[ null ('PGvararray ('NotNull 'PGtext))

268268 , null ('PGvararray ('NotNull 'PGtext)) ]

269− ---> null 'PGjsonb

269+ ( null 'PGjsonb )

270270jsonbZipObject = unsafeFunctionN "jsonb_object"

271271

272272{-----------------------------------------

@@ -274,31 +274,31 @@ Table 9.46: JSON processing functions

274274-----------------------------------------}

275275

276276-- | Returns the number of elements in the outermost JSON array.

277−jsonArrayLength :: null 'PGjson --> null 'PGint4

277+jsonArrayLength :: null 'PGjson :--> null 'PGint4

278278jsonArrayLength = unsafeFunction "json_array_length"

279279

280280-- | Returns the number of elements in the outermost binary JSON array.

281−jsonbArrayLength :: null 'PGjsonb --> null 'PGint4

281+jsonbArrayLength :: null 'PGjsonb :--> null 'PGint4

282282jsonbArrayLength = unsafeFunction "jsonb_array_length"

283283

284284-- | Returns the type of the outermost JSON value as a text string. Possible

285285-- types are object, array, string, number, boolean, and null.

286−jsonTypeof :: null 'PGjson --> null 'PGtext

286+jsonTypeof :: null 'PGjson :--> null 'PGtext

287287jsonTypeof = unsafeFunction "json_typeof"

288288

289289-- | Returns the type of the outermost binary JSON value as a text string.

290290-- Possible types are object, array, string, number, boolean, and null.

291−jsonbTypeof :: null 'PGjsonb --> null 'PGtext

291+jsonbTypeof :: null 'PGjsonb :--> null 'PGtext

292292jsonbTypeof = unsafeFunction "jsonb_typeof"

293293

294294-- | Returns its argument with all object fields that have null values omitted.

295295-- Other null values are untouched.

296−jsonStripNulls :: null 'PGjson --> null 'PGjson

296+jsonStripNulls :: null 'PGjson :--> null 'PGjson

297297jsonStripNulls = unsafeFunction "json_strip_nulls"

298298

299299-- | Returns its argument with all object fields that have null values omitted.

300300-- Other null values are untouched.

301−jsonbStripNulls :: null 'PGjsonb --> null 'PGjsonb

301+jsonbStripNulls :: null 'PGjsonb :--> null 'PGjsonb

302302jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

303303

304304-- | @ jsonbSet target path new_value create_missing @

@@ -309,9 +309,12 @@ jsonbStripNulls = unsafeFunction "jsonb_strip_nulls"

309309-- item designated by path does not exist. As with the path orientated

310310-- operators, negative integers that appear in path count from the end of JSON

311311-- arrays.

312−jsonbSet ::

313− '[ null 'PGjsonb, null ('PGvararray ('NotNull 'PGtext))

314− , null 'PGjsonb, null 'PGbool ] ---> null 'PGjsonb

312+jsonbSet

313+ :: FunctionN

314+ '[ null 'PGjsonb

315+ , null ('PGvararray ('NotNull 'PGtext))

316+ , null 'PGjsonb

317+ , null 'PGbool ] (null 'PGjsonb)

315318jsonbSet = unsafeFunctionN "jsonbSet"

316319

317320-- | @ jsonbInsert target path new_value insert_after @

@@ -323,23 +326,27 @@ jsonbSet = unsafeFunctionN "jsonbSet"

323326-- path is in JSONB object, @new_value@ will be inserted only if target does not

324327-- exist. As with the path orientated operators, negative integers that appear

325328-- 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

330+ :: FunctionN

331+ '[ null 'PGjsonb

332+ , null ('PGvararray ('NotNull 'PGtext))

333+ , null 'PGjsonb

334+ , null 'PGbool ] (null 'PGjsonb)

329335jsonbInsert = unsafeFunctionN "jsonb_insert"

330336

331337-- | Returns its argument as indented JSON text.

332−jsonbPretty :: null 'PGjsonb --> null 'PGtext

338+jsonbPretty :: null 'PGjsonb :--> null 'PGtext

333339jsonbPretty = unsafeFunction "jsonb_pretty"

334340

341+

335342{- | Expands the outermost JSON object into a set of key/value pairs.

336343

337344>>> printSQL (select Star (from (jsonEach (literal (Json (object ["a" .= "foo", "b" .= "bar"]))))))

338345SELECT * FROM json_each(('{"a":"foo","b":"bar"}' :: json))

339346-}

340−jsonEach :: SetFunction "json_each" (null 'PGjson)

347+jsonEach :: SetOfFunction "json_each" (null 'PGjson)

341348 '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]

342−jsonEach = unsafeSetFunction

349+jsonEach = unsafeSetOfFunction

343350

344351{- | Expands the outermost binary JSON object into a set of key/value pairs.

345352

@@ -347,9 +354,9 @@ jsonEach = unsafeSetFunction

347354SELECT * FROM jsonb_each(('{"a":"foo","b":"bar"}' :: jsonb))

348355-}

349356jsonbEach

350− :: SetFunction "jsonb_each" (nullity 'PGjsonb)

357+ :: SetOfFunction "jsonb_each" (nullity 'PGjsonb)

351358 '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGjson]

352−jsonbEach = unsafeSetFunction

359+jsonbEach = unsafeSetOfFunction

353360

354361{- | Expands the outermost JSON object into a set of key/value pairs.

355362

@@ -357,9 +364,9 @@ jsonbEach = unsafeSetFunction

357364SELECT * FROM json_each_text(('{"a":"foo","b":"bar"}' :: json))

358365-}

359366jsonEachText

360− :: SetFunction "json_each_text" (null 'PGjson)

367+ :: SetOfFunction "json_each_text" (null 'PGjson)

361368 '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

362−jsonEachText = unsafeSetFunction

369+jsonEachText = unsafeSetOfFunction

363370

364371{- | Expands the outermost binary JSON object into a set of key/value pairs.

365372

@@ -367,9 +374,9 @@ jsonEachText = unsafeSetFunction

367374SELECT * FROM jsonb_each_text(('{"a":"foo","b":"bar"}' :: jsonb))

368375-}

369376jsonbEachText

370− :: SetFunction "jsonb_each_text" (null 'PGjsonb)

377+ :: SetOfFunction "jsonb_each_text" (null 'PGjsonb)

371378 '["key" ::: 'NotNull 'PGtext, "value" ::: 'NotNull 'PGtext]

372−jsonbEachText = unsafeSetFunction

379+jsonbEachText = unsafeSetOfFunction

373380

374381{- | Returns set of keys in the outermost JSON object.

375382

@@ -377,9 +384,9 @@ jsonbEachText = unsafeSetFunction

377384json_object_keys(('{"a":"foo","b":"bar"}' :: json))

378385-}

379386jsonObjectKeys

380− :: SetFunction "json_object_keys" (nullity 'PGjson)

387+ :: SetOfFunction "json_object_keys" (nullity 'PGjson)

381388 '["json_object_keys" ::: 'NotNull 'PGtext]

382−jsonObjectKeys = unsafeSetFunction

389+jsonObjectKeys = unsafeSetOfFunction

383390

384391{- | Returns set of keys in the outermost JSON object.

385392

@@ -387,9 +394,9 @@ jsonObjectKeys = unsafeSetFunction

387394jsonb_object_keys(('{"a":"foo","b":"bar"}' :: jsonb))

388395-}

389396jsonbObjectKeys

390− :: SetFunction "jsonb_object_keys" (null 'PGjsonb)

397+ :: SetOfFunction "jsonb_object_keys" (null 'PGjsonb)

391398 '["jsonb_object_keys" ::: 'NotNull 'PGtext]

392−jsonbObjectKeys = unsafeSetFunction

399+jsonbObjectKeys = unsafeSetOfFunction

393400

394401-- | Build rows from Json types.

395402type JsonPopulateFunction fun json

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Logic.hs+1−1

@@ -47,7 +47,7 @@ false = UnsafeExpression "FALSE"

4747

4848-- | >>> printSQL $ not_ true

4949-- (NOT TRUE)

50−not_ :: null 'PGbool --> null 'PGbool

50+not_ :: null 'PGbool :--> null 'PGbool

5151not_ = unsafeLeftOp "NOT"

5252

5353-- | >>> printSQL $ true .&& false

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Math.hs+6−4

@@ -37,7 +37,9 @@ import Squeal.PostgreSQL.Schema

3737-- in printSQL expression

3838-- :}

3939-- atan2(pi(), 2)

40−atan2_ :: float `In` PGFloating => '[ null float, null float] ---> null float

40+atan2_

41+ :: float `In` PGFloating

42+ => FunctionN '[ null float, null float] (null float)

4143atan2_ = unsafeFunctionN "atan2"

4244

4345

@@ -76,7 +78,7 @@ rem_ = unsafeBinaryOp "%"

7678-- in printSQL expression

7779-- :}

7880-- trunc(pi())

79−trunc :: frac `In` PGFloating => null frac --> null frac

81+trunc :: frac `In` PGFloating => null frac :--> null frac

8082trunc = unsafeFunction "trunc"

8183

8284-- | >>> :{

@@ -86,7 +88,7 @@ trunc = unsafeFunction "trunc"

8688-- in printSQL expression

8789-- :}

8890-- round(pi())

89−round_ :: frac `In` PGFloating => null frac --> null frac

91+round_ :: frac `In` PGFloating => null frac :--> null frac

9092round_ = unsafeFunction "round"

9193

9294-- | >>> :{

@@ -96,5 +98,5 @@ round_ = unsafeFunction "round"

9698-- in printSQL expression

9799-- :}

98100-- ceiling(pi())

99−ceiling_ :: frac `In` PGFloating => null frac --> null frac

101+ceiling_ :: frac `In` PGFloating => null frac :--> null frac

100102ceiling_ = unsafeFunction "ceiling"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Null.hs+4−4

@@ -44,7 +44,7 @@ null_ = UnsafeExpression "NULL"

4444--

4545-- >>> printSQL $ notNull true

4646-- TRUE

47−notNull :: 'NotNull ty --> 'Null ty

47+notNull :: 'NotNull ty :--> 'Null ty

4848notNull = UnsafeExpression . renderSQL

4949

5050-- | return the leftmost value which is not NULL

@@ -69,12 +69,12 @@ fromNull notNullx nullx = coalesce [nullx] notNullx

6969

7070-- | >>> printSQL $ null_ & isNull

7171-- NULL IS NULL

72−isNull :: 'Null ty --> null 'PGbool

72+isNull :: 'Null ty :--> null 'PGbool

7373isNull x = UnsafeExpression $ renderSQL x <+> "IS NULL"

7474

7575-- | >>> printSQL $ null_ & isNotNull

7676-- NULL IS NOT NULL

77−isNotNull :: 'Null ty --> null 'PGbool

77+isNotNull :: 'Null ty :--> null 'PGbool

7878isNotNull x = UnsafeExpression $ renderSQL x <+> "IS NOT NULL"

7979

8080-- | analagous to `maybe` using @IS NULL@

@@ -100,5 +100,5 @@ matchNull y f x = ifThenElse (isNull x) y

100100>>> printSQL expr

101101NULLIF(FALSE, ($1 :: bool))

102102-}

103−nullIf :: '[ 'NotNull ty, 'NotNull ty] ---> 'Null ty

103+nullIf :: FunctionN '[ 'NotNull ty, 'NotNull ty] ('Null ty)

104104nullIf = unsafeFunctionN "NULLIF"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Range.hs+9−8

@@ -205,26 +205,27 @@ whole = NonEmpty Infinite Infinite

205205(@-) :: Operator (null ('PGrange ty)) (null ('PGrange ty)) (null ('PGrange ty))

206206(@-) = unsafeBinaryOp "-"

207207

208−lowerBound :: null ('PGrange ty) --> 'Null ty

208+lowerBound :: null ('PGrange ty) :--> 'Null ty

209209lowerBound = unsafeFunction "lower"

210210

211−upperBound :: null ('PGrange ty) --> 'Null ty

211+upperBound :: null ('PGrange ty) :--> 'Null ty

212212upperBound = unsafeFunction "upper"

213213

214−isEmpty :: null ('PGrange ty) --> 'Null 'PGbool

214+isEmpty :: null ('PGrange ty) :--> 'Null 'PGbool

215215isEmpty = unsafeFunction "isempty"

216216

217−lowerInc :: null ('PGrange ty) --> 'Null 'PGbool

217+lowerInc :: null ('PGrange ty) :--> 'Null 'PGbool

218218lowerInc = unsafeFunction "lower_inc"

219219

220−lowerInf :: null ('PGrange ty) --> 'Null 'PGbool

220+lowerInf :: null ('PGrange ty) :--> 'Null 'PGbool

221221lowerInf = unsafeFunction "lower_inf"

222222

223−upperInc :: null ('PGrange ty) --> 'Null 'PGbool

223+upperInc :: null ('PGrange ty) :--> 'Null 'PGbool

224224upperInc = unsafeFunction "upper_inc"

225225

226−upperInf :: null ('PGrange ty) --> 'Null 'PGbool

226+upperInf :: null ('PGrange ty) :--> 'Null 'PGbool

227227upperInf = unsafeFunction "upper_inf"

228228

229−rangeMerge :: '[null ('PGrange ty), null ('PGrange ty)] ---> null ('PGrange ty)

229+rangeMerge :: FunctionN

230+ '[ null ('PGrange ty), null ('PGrange ty)] (null ('PGrange ty))

230231rangeMerge = unsafeFunctionN "range_merge"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Set.hs → squeal-postgresql/src/Squeal/PostgreSQL/Expression/SetOf.hsrenamed+40−52

@@ -1,5 +1,5 @@

11{-|

2−Module: Squeal.PostgreSQL.Expression.Set

2+Module: Squeal.PostgreSQL.Expression.SetOf

33Description: Set returning functions

44Copyright: (c) Eitan Chatav, 2019

55Maintainer: eitan@morphism.tech

@@ -20,18 +20,16 @@ Set returning functions

2020 , TypeOperators

2121#-}

2222

23−module Squeal.PostgreSQL.Expression.Set

23+module Squeal.PostgreSQL.Expression.SetOf

2424 ( generateSeries

2525 , generateSeriesStep

2626 , generateSeriesTimestamp

27− , SetFunction

28− , unsafeSetFunction

29− , SetFunctionDB

30− , setFunction

31− , SetFunctionN

32− , unsafeSetFunctionN

33− , SetFunctionNDB

34− , setFunctionN

27+ , SetOfFunction

28+ , unsafeSetOfFunction

29+ , setOfFunction

30+ , SetOfFunctionN

31+ , unsafeSetOfFunctionN

32+ , setOfFunctionN

3533 ) where

3634

3735import GHC.TypeLits

@@ -48,65 +46,55 @@ import Squeal.PostgreSQL.Schema

4846{- |

4947A @RankNType@ for set returning functions with 1 argument.

5048-}

51−type SetFunction fun ty row

49+type SetOfFunction fun ty setof

5250 = forall outer commons schemas params

5351 . Expression outer commons 'Ungrouped schemas params '[] ty

5452 -- ^ 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]

53+ -> FromClause outer commons schemas params '[fun ::: setof]

6354 -- ^ output

6455

6556-- | 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 $

57+unsafeSetOfFunction

58+ :: forall fun ty setof. KnownSymbol fun

59+ => SetOfFunction fun ty setof -- ^ set returning function

60+unsafeSetOfFunction x = UnsafeFromClause $

7061 renderSymbol @fun <> parenthesized (renderSQL x)

7162

72−setFunction

63+setOfFunction

7364 :: ( 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

65+ , Has fun schema ('Function '[ty] ('ReturnsTable setof)) )

66+ => Alias fun

67+ -> ( forall outer commons params

68+ . Expression outer commons 'Ungrouped schemas params '[] ty

69+ -> FromClause outer commons schemas params '[fun ::: setof] )

70+setOfFunction _ = unsafeSetOfFunction

7871

7972{- |

8073A @RankNType@ for set returning functions with multiple argument.

8174-}

82−type SetFunctionN fun tys row

75+type SetOfFunctionN fun tys setof

8376 = forall outer commons schemas params

8477 . NP (Expression outer commons 'Ungrouped schemas params '[]) tys

8578 -- ^ inputs

86− -> FromClause outer commons schemas params '[fun ::: row]

79+ -> FromClause outer commons schemas params '[fun ::: setof]

8780 -- ^ output

8881

8982-- | 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 $

83+unsafeSetOfFunctionN

84+ :: forall fun tys setof. (SOP.SListI tys, KnownSymbol fun)

85+ => SetOfFunctionN fun tys setof -- ^ set returning function

86+unsafeSetOfFunctionN xs = UnsafeFromClause $

9487 renderSymbol @fun <> parenthesized (renderCommaSeparated renderSQL xs)

9588

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

89+setOfFunctionN

10490 :: ( Has sch schemas schema

105− , Has fun schema ('Function (tys :=> 'ReturnsTable row))

91+ , Has fun schema ('Function tys ('ReturnsTable setof))

10692 , SOP.SListI tys )

107− => QualifiedAlias sch fun

108− -> SetFunctionNDB fun schemas tys row

109−setFunctionN _ = unsafeSetFunctionN

93+ => Alias fun

94+ -> ( forall outer commons params

95+ . NP (Expression outer commons 'Ungrouped schemas params '[]) tys

96+ -> FromClause outer commons schemas params '[fun ::: setof] )

97+setOfFunctionN _ = unsafeSetOfFunctionN

11098

11199{- | @generateSeries (start *: stop)@

112100

@@ -114,9 +102,9 @@ Generate a series of values, from @start@ to @stop@ with a step size of one

114102-}

115103generateSeries

116104 :: ty `In` '[ 'PGint4, 'PGint8, 'PGnumeric]

117− => SetFunctionN "generate_series" '[ null ty, null ty]

105+ => SetOfFunctionN "generate_series" '[ null ty, null ty]

118106 '["generate_series" ::: null ty] -- ^ set returning function

119−generateSeries = unsafeSetFunctionN

107+generateSeries = unsafeSetOfFunctionN

120108

121109{- | @generateSeries (start :* stop *: step)@

122110

@@ -124,9 +112,9 @@ Generate a series of values, from @start@ to @stop@ with a step size of @step@

124112-}

125113generateSeriesStep

126114 :: ty `In` '[ 'PGint4, 'PGint8, 'PGnumeric]

127− => SetFunctionN "generate_series" '[null ty, null ty, null ty]

115+ => SetOfFunctionN "generate_series" '[null ty, null ty, null ty]

128116 '["generate_series" ::: null ty] -- ^ set returning function

129−generateSeriesStep = unsafeSetFunctionN

117+generateSeriesStep = unsafeSetOfFunctionN

130118

131119{- | @generateSeries (start :* stop *: step)@

132120

@@ -134,6 +122,6 @@ Generate a series of values, from @start@ to @stop@ with a step size of @step@

134122-}

135123generateSeriesTimestamp

136124 :: ty `In` '[ 'PGtimestamp, 'PGtimestamptz]

137− => SetFunctionN "generate_series" '[null ty, null ty, null 'PGinterval]

125+ => SetOfFunctionN "generate_series" '[null ty, null ty, null 'PGinterval]

138126 '["generate_series" ::: null ty] -- ^ set returning function

139−generateSeriesTimestamp = unsafeSetFunctionN

127+generateSeriesTimestamp = unsafeSetOfFunctionN

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Text.hs+3−3

@@ -30,17 +30,17 @@ import Squeal.PostgreSQL.Schema

3030

3131-- | >>> printSQL $ lower "ARRRGGG"

3232-- lower(E'ARRRGGG')

33−lower :: null 'PGtext --> null 'PGtext

33+lower :: null 'PGtext :--> null 'PGtext

3434lower = unsafeFunction "lower"

3535

3636-- | >>> printSQL $ upper "eeee"

3737-- upper(E'eeee')

38−upper :: null 'PGtext --> null 'PGtext

38+upper :: null 'PGtext :--> null 'PGtext

3939upper = unsafeFunction "upper"

4040

4141-- | >>> printSQL $ charLength "four"

4242-- char_length(E'four')

43−charLength :: null 'PGtext --> null 'PGint4

43+charLength :: null 'PGtext :--> null 'PGint4

4444charLength = unsafeFunction "char_length"

4545

4646-- | The `like` expression returns true if the @string@ matches

squeal-postgresql/src/Squeal/PostgreSQL/Expression/TextSearch.hs+20−19

@@ -55,7 +55,7 @@ import Squeal.PostgreSQL.Schema

5555(.|) = unsafeBinaryOp "||"

5656

5757-- | negate a `Squeal.PostgreSQL.Expression.Type.tsquery`

58−(.!) :: null 'PGtsquery --> null 'PGtsquery

58+(.!) :: null 'PGtsquery :--> null 'PGtsquery

5959(.!) = unsafeLeftOp "!!"

6060

6161-- | `Squeal.PostgreSQL.Expression.Type.tsquery` followed by

@@ -66,50 +66,51 @@ import Squeal.PostgreSQL.Schema

6666-- | convert array of lexemes to `Squeal.PostgreSQL.Expression.Type.tsvector`

6767arrayToTSvector

6868 :: null ('PGvararray ('NotNull 'PGtext))

69− --> null 'PGtsvector

69+ :--> null 'PGtsvector

7070arrayToTSvector = unsafeFunction "array_to_tsvector"

7171

7272-- | number of lexemes in `Squeal.PostgreSQL.Expression.Type.tsvector`

73−tsvectorLength :: null 'PGtsvector --> null 'PGint4

73+tsvectorLength :: null 'PGtsvector :--> null 'PGint4

7474tsvectorLength = unsafeFunction "length"

7575

7676-- | number of lexemes plus operators in `Squeal.PostgreSQL.Expression.Type.tsquery`

77−numnode :: null 'PGtsquery --> null 'PGint4

77+numnode :: null 'PGtsquery :--> null 'PGint4

7878numnode = unsafeFunction "numnode"

7979

8080-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` ignoring punctuation

81−plainToTSquery :: null 'PGtext --> null 'PGtsquery

81+plainToTSquery :: null 'PGtext :--> null 'PGtsquery

8282plainToTSquery = unsafeFunction "plainto_tsquery"

8383

8484-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` that searches for a phrase,

8585-- ignoring punctuation

86−phraseToTSquery :: null 'PGtext --> null 'PGtsquery

86+phraseToTSquery :: null 'PGtext :--> null 'PGtsquery

8787phraseToTSquery = unsafeFunction "phraseto_tsquery"

8888

8989-- | produce `Squeal.PostgreSQL.Expression.Type.tsquery` from a web search style query

90−websearchToTSquery :: null 'PGtext --> null 'PGtsquery

90+websearchToTSquery :: null 'PGtext :--> null 'PGtsquery

9191websearchToTSquery = unsafeFunction "websearch_to_tsquery"

9292

9393-- | get indexable part of a `Squeal.PostgreSQL.Expression.Type.tsquery`

94−queryTree :: null 'PGtsquery --> null 'PGtext

94+queryTree :: null 'PGtsquery :--> null 'PGtext

9595queryTree = unsafeFunction "query_tree"

9696

9797-- | normalize words and convert to `Squeal.PostgreSQL.Expression.Type.tsquery`

98−toTSquery :: null 'PGtext --> null 'PGtsquery

98+toTSquery :: null 'PGtext :--> null 'PGtsquery

9999toTSquery = unsafeFunction "to_tsquery"

100100

101101-- | reduce document text to `Squeal.PostgreSQL.Expression.Type.tsvector`

102102toTSvector

103103 :: ty `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

104− => null ty --> null 'PGtsvector

104+ => null ty :--> null 'PGtsvector

105105toTSvector = unsafeFunction "to_tsvector"

106106

107107-- | assign weight to each element of `Squeal.PostgreSQL.Expression.Type.tsvector`

108−setWeight :: '[null 'PGtsvector, null ('PGchar 1)] ---> null 'PGtsvector

108+setWeight

109+ :: FunctionN '[null 'PGtsvector, null ('PGchar 1)] (null 'PGtsvector)

109110setWeight = unsafeFunctionN "set_weight"

110111

111112-- | remove positions and weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

112−strip :: null 'PGtsvector --> null 'PGtsvector

113+strip :: null 'PGtsvector :--> null 'PGtsvector

113114strip = unsafeFunction "strip"

114115

115116-- | @jsonToTSvector (document *: filter)@

@@ -122,7 +123,7 @@ strip = unsafeFunction "strip"

122123-- "boolean" (to include all Boolean values in the string format "true"/"false"),

123124-- "key" (to include all keys) or "all" (to include all above).

124125-- 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 :: FunctionN '[null 'PGjson, null 'PGjson] (null 'PGtsvector)

126127jsonToTSvector = unsafeFunctionN "json_to_tsvector"

127128

128129-- | @jsonbToTSvector (document *: filter)@

@@ -135,23 +136,23 @@ jsonToTSvector = unsafeFunctionN "json_to_tsvector"

135136-- "boolean" (to include all Boolean values in the string format "true"/"false"),

136137-- "key" (to include all keys) or "all" (to include all above).

137138-- 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 :: FunctionN '[null 'PGjsonb, null 'PGjsonb] (null 'PGtsvector)

139140jsonbToTSvector = unsafeFunctionN "jsonb_to_tsvector"

140141

141142-- | remove given lexeme from `Squeal.PostgreSQL.Expression.Type.tsvector`

142−tsDelete ::

143+tsDelete :: FunctionN

143144 '[null 'PGtsvector, null ('PGvararray ('NotNull 'PGtext))]

144− ---> null 'PGtsvector

145+ (null 'PGtsvector)

145146tsDelete = unsafeFunctionN "ts_delete"

146147

147148-- | select only elements with given weights from `Squeal.PostgreSQL.Expression.Type.tsvector`

148−tsFilter ::

149+tsFilter :: FunctionN

149150 '[null 'PGtsvector, null ('PGvararray ('NotNull ('PGchar 1)))]

150− ---> null 'PGtsvector

151+ (null 'PGtsvector)

151152tsFilter = unsafeFunctionN "ts_filter"

152153

153154-- | display a `Squeal.PostgreSQL.Expression.Type.tsquery` match

154155tsHeadline

155156 :: document `In` '[ 'PGtext, 'PGjson, 'PGjsonb]

156− => '[null document, null 'PGtsquery] ---> null 'PGtext

157+ => FunctionN '[null document, null 'PGtsquery] (null 'PGtext)

157158tsHeadline = unsafeFunctionN "ts_headline"

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Time.hs+12−7

@@ -17,7 +17,6 @@ Date/Time functions and operators

1717 , OverloadedStrings

1818 , PolyKinds

1919 , RankNTypes

20− , TypeOperators

2120#-}

2221

2322module Squeal.PostgreSQL.Expression.Time

@@ -86,7 +85,9 @@ Create date from year, month and day fields

8685>>> printSQL (makeDate (1984 :* 7 *: 3))

8786make_date(1984, 7, 3)

8887-}

89−makeDate :: '[ null 'PGint4, null 'PGint4, null 'PGint4 ] ---> null 'PGdate

88+makeDate :: FunctionN

89+ '[ null 'PGint4, null 'PGint4, null 'PGint4 ]

90+ ( null 'PGdate )

9091makeDate = unsafeFunctionN "make_date"

9192

9293{-|

@@ -95,7 +96,9 @@ Create time from hour, minute and seconds fields

9596>>> printSQL (makeTime (8 :* 15 *: 23.5))

9697make_time(8, 15, 23.5)

9798-}

98−makeTime :: '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtime

99+makeTime :: FunctionN

100+ '[ null 'PGint4, null 'PGint4, null 'PGfloat8 ]

101+ ( null 'PGtime )

99102makeTime = unsafeFunctionN "make_time"

100103

101104{-|

@@ -104,9 +107,10 @@ Create timestamp from year, month, day, hour, minute and seconds fields

104107>>> printSQL (makeTimestamp (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

105108make_timestamp(2013, 7, 15, 8, 15, 23.5)

106109-}

107−makeTimestamp ::

110+makeTimestamp :: FunctionN

108111 '[ null 'PGint4, null 'PGint4, null 'PGint4

109− , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamp

112+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ]

113+ ( null 'PGtimestamp )

110114makeTimestamp = unsafeFunctionN "make_timestamp"

111115

112116{-|

@@ -117,9 +121,10 @@ the current time zone is used

117121>>> printSQL (makeTimestamptz (2013 :* 7 :* 15 :* 8 :* 15 *: 23.5))

118122make_timestamptz(2013, 7, 15, 8, 15, 23.5)

119123-}

120−makeTimestamptz ::

124+makeTimestamptz :: FunctionN

121125 '[ null 'PGint4, null 'PGint4, null 'PGint4

122− , null 'PGint4, null 'PGint4, null 'PGfloat8 ] ---> null 'PGtimestamptz

126+ , null 'PGint4, null 'PGint4, null 'PGfloat8 ]

127+ ( null 'PGtimestamptz )

123128makeTimestamptz = unsafeFunctionN "make_timestamptz"

124129

125130{-|

squeal-postgresql/src/Squeal/PostgreSQL/Expression/Type.hs+3−108

@@ -23,16 +23,14 @@ Type expressions.

2323 , ScopedTypeVariables

2424 , TypeApplications

2525 , TypeOperators

26− , UndecidableInstances

2726#-}

2827

2928module Squeal.PostgreSQL.Expression.Type

30− ( -- * type casting

31− cast

29+ ( TypeExpression (..)

30+ , cast

3231 , astype

3332 , inferredtype

34− -- * type expressions

35− , TypeExpression (..)

33+ , PGTyped (..)

3634 , typedef

3735 , typetable

3836 , typeview

@@ -79,22 +77,6 @@ module Squeal.PostgreSQL.Expression.Type

7977 , tsrange

8078 , tstzrange

8179 , 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 (..)

9880 ) where

9981

10082import Control.DeepSeq

@@ -108,7 +90,6 @@ import qualified Generics.SOP as SOP

10890

10991import Squeal.PostgreSQL.Alias

11092import Squeal.PostgreSQL.Expression

111−import Squeal.PostgreSQL.PG

11293import Squeal.PostgreSQL.Render

11394import Squeal.PostgreSQL.Schema

11495

@@ -150,7 +131,6 @@ astype = cast

150131inferredtype

151132 :: PGTyped schemas ty

152133 => Expression outer common grp schemas params from ty

153− -- ^ value

154134 -> Expression outer common grp schemas params from ty

155135inferredtype = astype pgtype

156136

@@ -170,7 +150,6 @@ instance RenderSQL (TypeExpression schemas ty) where

170150typedef

171151 :: (Has sch schemas schema, Has td schema ('Typedef ty))

172152 => QualifiedAlias sch td

173− -- ^ type alias

174153 -> TypeExpression schemas (null ty)

175154typedef = UnsafeTypeExpression . renderSQL

176155

@@ -179,7 +158,6 @@ typedef = UnsafeTypeExpression . renderSQL

179158typetable

180159 :: (Has sch schemas schema, Has tab schema ('Table table))

181160 => QualifiedAlias sch tab

182− -- ^ table alias

183161 -> TypeExpression schemas (null ('PGcomposite (TableToRow table)))

184162typetable = UnsafeTypeExpression . renderSQL

185163

@@ -188,7 +166,6 @@ typetable = UnsafeTypeExpression . renderSQL

188166typeview

189167 :: (Has sch schemas schema, Has vw schema ('View view))

190168 => QualifiedAlias sch vw

191− -- ^ view alias

192169 -> TypeExpression schemas (null ('PGcomposite view))

193170typeview = UnsafeTypeExpression . renderSQL

194171

@@ -362,85 +339,3 @@ instance (SOP.All KnownNat dims, PGTyped schemas ty)

362339instance PGTyped schemas (null 'PGtsvector) where pgtype = tsvector

363340instance PGTyped schemas (null 'PGtsquery) where pgtype = tsquery

364341instance 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/List.hs+2−11

@@ -84,12 +84,7 @@ infixl 9 *:

8484-- | @Elem@ is a promoted `Data.List.elem`.

8585type family Elem x xs where

8686 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

87+ Elem x (x ': xs) = 'True

9388 Elem x (_ ': xs) = Elem x xs

9489

9590-- | @In x xs@ is a constraint that proves that @x@ is in @xs@.

@@ -104,9 +99,5 @@ Length '[Char,String,Bool,Double] :: Nat

10499= 4

105100-}

106101type 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

102+ Length (x : xs) = 1 + Length xs

112103 Length '[] = 0

squeal-postgresql/src/Squeal/PostgreSQL/Migration.hs−2

@@ -167,8 +167,6 @@ import qualified GHC.Generics as GHC

167167import Squeal.PostgreSQL.Alias

168168import Squeal.PostgreSQL.Binary

169169import Squeal.PostgreSQL.Definition

170−import Squeal.PostgreSQL.Definition.Table

171−import Squeal.PostgreSQL.Definition.Table.Constraint

172170import Squeal.PostgreSQL.Expression.Comparison

173171import Squeal.PostgreSQL.Expression.Parameter

174172import Squeal.PostgreSQL.Expression.Time

squeal-postgresql/src/Squeal/PostgreSQL/PG.hs+12−22

@@ -47,7 +47,7 @@ module Squeal.PostgreSQL.PG

4747 , Enumerated (..)

4848 , VarArray (..)

4949 , FixArray (..)

50− , LibPQ.Oid (..)

50+ , Oid (..)

5151 -- * Type families

5252 , LabelsPG

5353 , DimPG

@@ -66,6 +66,7 @@ import Data.Int (Int16, Int32, Int64)

6666import Data.Scientific (Scientific)

6767import Data.Time (Day, DiffTime, LocalTime, TimeOfDay, TimeZone, UTCTime)

6868import Data.Vector (Vector)

69+import Data.Word (Word32)

6970import Data.UUID.Types (UUID)

7071import GHC.TypeLits

7172import Network.IP.Addr (NetAddr, IP)

@@ -74,7 +75,6 @@ import qualified Data.ByteString.Lazy as Lazy (ByteString)

7475import qualified Data.ByteString as Strict (ByteString)

7576import qualified Data.Text.Lazy as Lazy (Text)

7677import qualified Data.Text as Strict (Text)

77−import qualified Database.PostgreSQL.LibPQ as LibPQ

7878import qualified GHC.Generics as GHC

7979import qualified Generics.SOP as SOP

8080import qualified Generics.SOP.Record as SOP

@@ -108,7 +108,7 @@ type instance PG Int32 = 'PGint4

108108-- | `PGint8`

109109type instance PG Int64 = 'PGint8

110110-- | `PGint2`

111−type instance PG LibPQ.Oid = 'PGoid

111+type instance PG Oid = 'PGoid

112112-- | `PGnumeric`

113113type instance PG Scientific = 'PGnumeric

114114-- | `PGfloat4`

@@ -178,16 +178,8 @@ type family RowPG (hask :: Type) :: RowType where

178178

179179-- | `RowOf` applies `NullPG` to the fields of a list.

180180type 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

190181 RowOf '[] = '[]

182+ RowOf (col ::: ty ': record) = col ::: NullPG ty ': RowOf record

191183

192184{- | `NullPG` turns a Haskell type into a `NullityType`.

193185

@@ -214,17 +206,8 @@ type family TuplePG (hask :: Type) :: [NullityType] where

214206

215207-- | `TupleOf` turns a list of Haskell `Type`s into a list of `NullityType`s.

216208type 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

227209 TupleOf '[] = '[]

210+ TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple

228211

229212-- | `TupleCodeOf` takes the `SOP.Code` of a haskell `Type`

230213-- and if it's a simple product returns it, otherwise giving a `TypeError`.

@@ -386,3 +369,10 @@ newtype FixArray arr = FixArray {getFixArray :: arr}

386369 deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

387370-- | `PGfixarray` @(@`DimPG` @hask) (@`FixPG` @hask)@

388371type instance PG (FixArray hask) = 'PGfixarray (DimPG hask) (FixPG hask)

372+

373+{- | Object identifiers (`Oid`s) are used internally by PostgreSQL

374+as primary keys for various system tables.

375+-}

376+newtype Oid = Oid { getOid :: Word32 }

377+ deriving stock (Eq, Ord, Show, Read, GHC.Generic)

378+ deriving anyclass (SOP.HasDatatypeInfo, SOP.Generic)

squeal-postgresql/src/Squeal/PostgreSQL/PQ.hs+17−41

@@ -78,7 +78,6 @@ import UnliftIO (MonadUnliftIO (..), bracket, catch, handle, try)

7878import Data.ByteString (ByteString)

7979import Data.Foldable

8080import Data.Function ((&))

81−import Data.Functor ((<&>))

8281import Data.Kind

8382import Data.Text (pack, Text)

8483import Data.Traversable

@@ -87,7 +86,6 @@ import PostgreSQL.Binary.Encoding (encodingBytes)

8786

8887import qualified Control.Monad.Fail as Fail

8988import qualified Database.PostgreSQL.LibPQ as LibPQ

90−import qualified PostgreSQL.Binary.Encoding as Encoding

9189

9290import Squeal.PostgreSQL.Binary

9391import Squeal.PostgreSQL.Definition

@@ -317,13 +315,13 @@ a default instance.

317315-}

318316class Monad pq => MonadPQ schemas pq | pq -> schemas where

319317 manipulateParams

320− :: (ToParams x params, All OidOfParam params)

318+ :: ToParams x params

321319 => Manipulation '[] schemas params ys

322320 -- ^ `insertInto`, `update` or `deleteFrom`

323321 -> x -> pq (K LibPQ.Result ys)

324322 default manipulateParams

325323 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

326− => (ToParams x params, All OidOfParam params)

324+ => ToParams x params

327325 => Manipulation '[] schemas params ys

328326 -- ^ `insertInto`, `update` or `deleteFrom`

329327 -> x -> pq (K LibPQ.Result ys)

@@ -331,7 +329,7 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

331329 manipulateParams manipulation params

332330

333331 manipulateParams_

334− :: (ToParams x params, All OidOfParam params)

332+ :: ToParams x params

335333 => Manipulation '[] schemas params '[]

336334 -- ^ `insertInto`, `update` or `deleteFrom`

337335 -> x -> pq ()

@@ -344,7 +342,7 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

344342 manipulate_ = void . manipulate

345343

346344 runQueryParams

347− :: (ToParams x params, All OidOfParam params)

345+ :: ToParams x params

348346 => Query '[] '[] schemas params ys

349347 -- ^ `select` and friends

350348 -> x -> pq (K LibPQ.Result ys)

@@ -357,19 +355,19 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

357355 runQuery q = runQueryParams q ()

358356

359357 traversePrepared

360− :: (ToParams x params, Traversable list, All OidOfParam params)

358+ :: (ToParams x params, Traversable list)

361359 => Manipulation '[] schemas params ys

362360 -- ^ `insertInto`, `update`, or `deleteFrom`, and friends

363361 -> list x -> pq (list (K LibPQ.Result ys))

364362 default traversePrepared

365363 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

366− => (ToParams x params, Traversable list, All OidOfParam params)

364+ => (ToParams x params, Traversable list)

367365 => Manipulation '[] schemas params ys -> list x -> pq (list (K LibPQ.Result ys))

368366 traversePrepared manipulation params = lift $

369367 traversePrepared manipulation params

370368

371369 forPrepared

372− :: (ToParams x params, Traversable list, All OidOfParam params)

370+ :: (ToParams x params, Traversable list)

373371 => list x

374372 -> Manipulation '[] schemas params ys

375373 -- ^ `insertInto`, `update` or `deleteFrom`

@@ -377,13 +375,13 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

377375 forPrepared = flip traversePrepared

378376

379377 traversePrepared_

380− :: (ToParams x params, Foldable list, All OidOfParam params)

378+ :: (ToParams x params, Foldable list)

381379 => Manipulation '[] schemas params '[]

382380 -- ^ `insertInto`, `update` or `deleteFrom`

383381 -> list x -> pq ()

384382 default traversePrepared_

385383 :: (MonadTrans t, MonadPQ schemas pq1, pq ~ t pq1)

386− => (ToParams x params, Foldable list, All OidOfParam params)

384+ => (ToParams x params, Foldable list)

387385 => Manipulation '[] schemas params '[]

388386 -- ^ `insertInto`, `update` or `deleteFrom`

389387 -> list x -> pq ()

@@ -391,7 +389,7 @@ class Monad pq => MonadPQ schemas pq | pq -> schemas where

391389 traversePrepared_ manipulation params

392390

393391 forPrepared_

394− :: (ToParams x params, Foldable list, All OidOfParam params)

392+ :: (ToParams x params, Foldable list)

395393 => list x

396394 -> Manipulation '[] schemas params '[]

397395 -- ^ `insertInto`, `update` or `deleteFrom`

@@ -411,17 +409,9 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

411409 (UnsafeManipulation q :: Manipulation '[] schemas ps ys) (params :: x) =

412410 PQ $ \ (K conn) -> do

413411 let

414− paramSet

415− :: forall param. OidOfParam param

416− => K (Maybe Encoding.Encoding) param

417− -> K (Maybe (LibPQ.Oid, ByteString, LibPQ.Format)) param

418− paramSet (K maybeEncoding) = K $

419− maybeEncoding <&> \encoding ->

420− (oidOfParam @param, encodingBytes encoding, LibPQ.Binary)

421− params'

422− = hcollapse

423− . hcmap (Proxy @OidOfParam) paramSet

424− $ toParams @x @ps params

412+ toParam' encoding =

413+ (LibPQ.invalidOid, encodingBytes encoding, LibPQ.Binary)

414+ params' = fmap (fmap toParam') (hcollapse (toParams @x @ps params))

425415 q' = q <> ";"

426416 resultMaybe <- liftIO $ LibPQ.execParams conn q' params' LibPQ.Binary

427417 case resultMaybe of

@@ -434,15 +424,8 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

434424 traversePrepared

435425 (UnsafeManipulation q :: Manipulation '[] schemas xs ys) (list :: list x) =

436426 PQ $ \ (K conn) -> liftIO $ do

437− let

438− temp = "temporary_statement"

439− paramOid :: forall p. OidOfParam p => K LibPQ.Oid p

440− paramOid = K (oidOfParam @p)

441− paramOids :: NP (K LibPQ.Oid) xs

442− paramOids = hcpure (Proxy @OidOfParam) paramOid

443− paramOids' :: [LibPQ.Oid]

444− paramOids' = hcollapse paramOids

445− prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

427+ let temp = "temporary_statement"

428+ prepResultMaybe <- LibPQ.prepare conn temp q Nothing

446429 case prepResultMaybe of

447430 Nothing -> throw $ ResultException

448431 "traversePrepared: LibPQ.prepare returned no results"

@@ -468,15 +451,8 @@ instance (MonadIO io, schemas0 ~ schemas, schemas1 ~ schemas)

468451 traversePrepared_

469452 (UnsafeManipulation q :: Manipulation '[] schemas xs '[]) (list :: list x) =

470453 PQ $ \ (K conn) -> liftIO $ do

471− let

472− temp = "temporary_statement"

473− paramOid :: forall p. OidOfParam p => K LibPQ.Oid p

474− paramOid = K (oidOfParam @p)

475− paramOids :: NP (K LibPQ.Oid) xs

476− paramOids = hcpure (Proxy @OidOfParam) paramOid

477− paramOids' :: [LibPQ.Oid]

478− paramOids' = hcollapse paramOids

479− prepResultMaybe <- LibPQ.prepare conn temp q (Just paramOids')

454+ let temp = "temporary_statement"

455+ prepResultMaybe <- LibPQ.prepare conn temp q Nothing

480456 case prepResultMaybe of

481457 Nothing -> throw $ ResultException

482458 "traversePrepared_: LibPQ.prepare returned no results"

squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+25−33

@@ -554,9 +554,9 @@ select_ = select . List

554554-- be subject to the elimination of duplicate rows using `selectDistinct`.

555555selectDistinct

556556 :: (SListI columns, columns ~ (col ': cols))

557− => Selection outer commons grp schemas params from columns

557+ => Selection outer commons 'Ungrouped schemas params from columns

558558 -- ^ selection

559− -> TableExpression outer commons grp schemas params from

559+ -> TableExpression outer commons 'Ungrouped schemas params from

560560 -- ^ intermediate virtual table

561561 -> Query outer commons schemas params columns

562562selectDistinct selection tabexpr = UnsafeQuery $

@@ -568,9 +568,9 @@ selectDistinct selection tabexpr = UnsafeQuery $

568568-- of a general `Selection`.

569569selectDistinct_

570570 :: (SListI columns, columns ~ (col ': cols))

571− => NP (Aliased (Expression outer commons grp schemas params from)) columns

571+ => NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns

572572 -- ^ select list

573− -> TableExpression outer commons grp schemas params from

573+ -> TableExpression outer commons 'Ungrouped schemas params from

574574 -- ^ intermediate virtual table

575575 -> Query outer commons schemas params columns

576576selectDistinct_ = selectDistinct . List

@@ -580,21 +580,14 @@ selectDistinct_ = selectDistinct . List

580580the given expressions evaluate to equal. The DISTINCT ON expressions are

581581interpreted using the same rules as for ORDER BY. ORDER BY is used to

582582ensure 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.

590583-}

591584selectDistinctOn

592585 :: (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

586+ => [SortExpression outer commons 'Ungrouped schemas params from]

587+ -- ^ distinct on and return the first row in ordering

588+ -> Selection outer commons 'Ungrouped schemas params from columns

596589 -- ^ selection

597− -> TableExpression outer commons grp schemas params from

590+ -> TableExpression outer commons 'Ungrouped schemas params from

598591 -- ^ intermediate virtual table

599592 -> Query outer commons schemas params columns

600593selectDistinctOn distincts selection tab = UnsafeQuery $

@@ -615,11 +608,11 @@ selectDistinctOn distincts selection tab = UnsafeQuery $

615608-- of a general `Selection`.

616609selectDistinctOn_

617610 :: (SListI columns, columns ~ (col ': cols))

618− => [SortExpression outer commons grp schemas params from]

611+ => [SortExpression outer commons 'Ungrouped schemas params from]

619612 -- ^ distinct on and return the first row in ordering

620− -> NP (Aliased (Expression outer commons grp schemas params from)) columns

613+ -> NP (Aliased (Expression outer commons 'Ungrouped schemas params from)) columns

621614 -- ^ selection

622− -> TableExpression outer commons grp schemas params from

615+ -> TableExpression outer commons 'Ungrouped schemas params from

623616 -- ^ intermediate virtual table

624617 -> Query outer commons schemas params columns

625618selectDistinctOn_ distincts = selectDistinctOn distincts . List

@@ -757,7 +750,7 @@ instance RenderSQL (TableExpression outer commons grp schemas params from) where

757750from

758751 :: FromClause outer commons schemas params from -- ^ table reference

759752 -> TableExpression outer commons 'Ungrouped schemas params from

760−from tab = TableExpression tab [] noGroups NoHaving [] [] []

753+from tab = TableExpression tab [] NoGroups NoHaving [] [] []

761754

762755-- | A `where_` is an endomorphism of `TableExpression`s which adds a

763756-- search condition to the `whereClause`.

@@ -778,7 +771,7 @@ groupBy

778771groupBy bys rels = TableExpression

779772 { fromClause = fromClause rels

780773 , whereClause = whereClause rels

781− , groupByClause = group bys

774+ , groupByClause = Group bys

782775 , havingClause = Having []

783776 , orderByClause = []

784777 , limitClause = limitClause rels

@@ -992,20 +985,19 @@ instance (Has rel rels cols, Has col cols ty, bys ~ '[ '(rel, col)])

992985-- done on @NoGroups@ while all output `Expression`s must be aggregated

993986-- in @Group Nil@. In general, all output `Expression`s in the

994987-- complement of @bys@ must be aggregated in @Group bys@.

995−newtype GroupByClause grp from = UnsafeGroupByClause

996− { renderGroupByClause :: ByteString }

997− deriving (GHC.Generic,Show,Eq,Ord,NFData)

988+data GroupByClause grp from where

989+ NoGroups :: GroupByClause 'Ungrouped from

990+ Group

991+ :: SListI bys

992+ => NP (By from) bys

993+ -> GroupByClause ('Grouped bys) from

994+

995+-- | Renders a `GroupByClause`.

998996instance RenderSQL (GroupByClause grp from) where

999− renderSQL = renderGroupByClause

1000−noGroups :: GroupByClause 'Ungrouped from

1001−noGroups = UnsafeGroupByClause ""

1002−group

1003− :: SListI bys

1004− => NP (By from) bys

1005− -> GroupByClause ('Grouped bys) from

1006−group bys = UnsafeGroupByClause $ case bys of

1007− Nil -> ""

1008− bys' -> " GROUP BY" <+> renderCommaSeparated renderSQL bys'

997+ renderSQL = \case

998+ NoGroups -> ""

999+ Group Nil -> ""

1000+ Group bys -> " GROUP BY" <+> renderCommaSeparated renderSQL bys

10091001

10101002-- | A `HavingClause` is used to eliminate groups that are not of interest.

10111003-- An `Ungrouped` `TableExpression` may only use `NoHaving` while a `Grouped`

squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+11−141

@@ -44,8 +44,6 @@ module Squeal.PostgreSQL.Schema

4444 , ColumnsType

4545 , TableType

4646 , SchemumType (..)

47− , IndexType (..)

48− , FunctionType

4947 , OperatorType (..)

5048 , ReturnsType (..)

5149 , SchemaType

@@ -62,16 +60,9 @@ module Squeal.PostgreSQL.Schema

6260 , PGlabel (..)

6361 -- * Data Definitions

6462 , Create

65− , CreateIfNotExists

66− , CreateOrReplace

6763 , Drop

68− , DropSchemum

69− , DropIfExists

70− , DropSchemumIfExists

7164 , Alter

72− , AlterIfExists

7365 , Rename

74− , RenameIfExists

7566 , ConstraintInvolves

7667 , DropIfConstraintsInvolve

7768 , IsNotElem

@@ -260,19 +251,9 @@ type FromType = [(Symbol,RowType)]

260251

261252-- | `ColumnsToRow` removes column constraints.

262253type family ColumnsToRow (columns :: ColumnsType) :: RowType where

263− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': column4 ::: _ :=> ty4 ': column5 ::: _ :=> ty5 ': columns) =

264− column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': column5 ::: ty5 ': ColumnsToRow columns

265− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': column4 ::: _ :=> ty4 ': columns) =

266− column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': ColumnsToRow columns

267− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': column3 ::: _ :=> ty3 ': columns) =

268− column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': ColumnsToRow columns

269− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': column2 ::: _ :=> ty2 ': columns) =

270− column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': ColumnsToRow columns

271− ColumnsToRow (column ::: _ :=> ty ': column1 ::: _ :=> ty1 ': columns) =

272− column ::: ty ': column1 ::: ty1 ': ColumnsToRow columns

273− ColumnsToRow (column ::: _ :=> ty ': columns) =

274− column ::: ty ': ColumnsToRow columns

275254 ColumnsToRow '[] = '[]

255+ ColumnsToRow (column ::: constraint :=> ty ': columns) =

256+ column ::: ty ': ColumnsToRow columns

276257

277258-- | `TableToColumns` removes table constraints.

278259type family TableToColumns (table :: TableType) :: ColumnsType where

@@ -305,24 +286,14 @@ instance ty0 ~ ty1 => SamePGType

305286

306287-- | `AllNotNull` is a constraint that proves a `ColumnsType` has no @NULL@s.

307288type 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

314289 AllNotNull '[] = ()

290+ AllNotNull (column ::: def :=> 'NotNull ty ': columns) = AllNotNull columns

315291

316292-- | `NotAllNull` is a constraint that proves a `ColumnsType` has some

317293-- @NOT NULL@.

318294type family NotAllNull (columns :: ColumnsType) :: Constraint where

319− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

320− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

321− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

322− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

323− NotAllNull (_ ::: _ :=> _ _ ': _ ::: _ :=> 'NotNull _ ': _) = ()

324− NotAllNull (_ ::: _ :=> 'NotNull _ ': _) = ()

325− NotAllNull (_ ::: _ :=> 'Null _ ': columns) = NotAllNull columns

295+ NotAllNull (column ::: def :=> 'NotNull ty ': columns) = ()

296+ NotAllNull (column ::: def :=> 'Null ty ': columns) = NotAllNull columns

326297

327298-- | `NullifyType` is an idempotent that nullifies a `NullityType`.

328299type family NullifyType (ty :: NullityType) :: NullityType where

@@ -331,37 +302,17 @@ type family NullifyType (ty :: NullityType) :: NullityType where

331302

332303-- | `NullifyRow` is an idempotent that nullifies a `RowType`.

333304type family NullifyRow (columns :: RowType) :: RowType where

334− NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': column5 ::: ty5 ': columns) =

335− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': column4 ::: NullifyType ty4 ': column5 ::: NullifyType ty5 ': NullifyRow columns

336− NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': column4 ::: ty4 ': columns) =

337− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': column4 ::: NullifyType ty4 ': NullifyRow columns

338− NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': column3 ::: ty3 ': columns) =

339− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': column3 ::: NullifyType ty3 ': NullifyRow columns

340− NullifyRow (column ::: ty ': column1 ::: ty1 ': column2 ::: ty2 ': columns) =

341− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': column2 ::: NullifyType ty2 ': NullifyRow columns

342− NullifyRow (column ::: ty ': column1 ::: ty1 ': columns) =

343− column ::: NullifyType ty ': column1 ::: NullifyType ty1 ': NullifyRow columns

305+ NullifyRow '[] = '[]

344306 NullifyRow (column ::: ty ': columns) =

345307 column ::: NullifyType ty ': NullifyRow columns

346− NullifyRow '[] = '[]

347308

348309-- | `NullifyFrom` is an idempotent that nullifies a `FromType`

349310-- used to nullify the left or right hand side of an outer join

350311-- in a `Squeal.PostgreSQL.Query.FromClause`.

351312type family NullifyFrom (tables :: FromType) :: FromType where

352− NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': table4 ::: columns4 ': table5 ::: columns5 ': tables) =

353− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': table4 ::: NullifyRow columns5 ': table5 ::: NullifyRow columns4 ': NullifyFrom tables

354− NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': table4 ::: columns4 ': tables) =

355− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': table4 ::: NullifyRow columns4 ': NullifyFrom tables

356− NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': table3 ::: columns3 ': tables) =

357− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': table3 ::: NullifyRow columns3 ': NullifyFrom tables

358− NullifyFrom (table ::: columns ': table1 ::: columns1 ': table2 ::: columns2 ': tables) =

359− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': table2 ::: NullifyRow columns2 ': NullifyFrom tables

360− NullifyFrom (table ::: columns ': table1 ::: columns1 ': tables) =

361− table ::: NullifyRow columns ': table1 ::: NullifyRow columns1 ': NullifyFrom tables

313+ NullifyFrom '[] = '[]

362314 NullifyFrom (table ::: columns ': tables) =

363315 table ::: NullifyRow columns ': NullifyFrom tables

364− NullifyFrom '[] = '[]

365316

366317-- | @Create alias x xs@ adds @alias ::: x@ to the end of @xs@ and is used in

367318-- `Squeal.PostgreSQL.Definition.createTable` statements and in @ALTER TABLE@

@@ -371,101 +322,30 @@ type family Create alias x xs where

371322 Create alias x (alias ::: y ': xs) = TypeError

372323 ('Text "Create: alias "

373324 ':<>: 'ShowType alias

374− ':<>: 'Text "already exists")

325+ ':<>: 'Text "already in use")

375326 Create alias y (x ': xs) = x ': Create alias y xs

376327

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−

394328-- | @Drop alias xs@ removes the type associated with @alias@ in @xs@

395329-- and is used in `Squeal.PostgreSQL.Definition.dropTable` statements

396330-- and in @ALTER TABLE@ `Squeal.PostgreSQL.Definition.dropColumn` statements.

397331type family Drop alias xs where

398− Drop alias '[] = TypeError

399− ('Text "Drop: alias "

400− ':<>: 'ShowType alias

401− ':<>: 'Text " does not exist" )

402− Drop alias (alias ::: x ': xs) = xs

332+ Drop alias ((alias ::: x) ': xs) = xs

403333 Drop alias (x ': xs) = x ': Drop alias xs

404334

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−

437335-- | @Alter alias x xs@ replaces the type associated with an @alias@ in @xs@

438336-- with the type @x@ and is used in `Squeal.PostgreSQL.Definition.alterTable`

439337-- and `Squeal.PostgreSQL.Definition.alterColumn`.

440338type family Alter alias x xs where

441− Alter alias x '[] = TypeError

442− ('Text "Alter: alias "

443− ':<>: 'ShowType alias

444− ':<>: 'Text " does not exist" )

445339 Alter alias x1 (alias ::: x0 ': xs) = alias ::: x1 ': xs

446340 Alter alias x1 (x0 ': xs) = x0 ': Alter alias x1 xs

447341

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−

453342-- | @Rename alias0 alias1 xs@ replaces the alias @alias0@ by @alias1@ in @xs@

454343-- and is used in `Squeal.PostgreSQL.Definition.alterTableRename` and

455344-- `Squeal.PostgreSQL.Definition.renameColumn`.

456345type family Rename alias0 alias1 xs where

457− Rename alias0 alias1 '[] = TypeError

458− ('Text "Rename: alias "

459− ':<>: 'ShowType alias0

460− ':<>: 'Text " does not exist" )

461346 Rename alias0 alias1 ((alias0 ::: x0) ': xs) = (alias1 ::: x0) ': xs

462347 Rename alias0 alias1 (x ': xs) = x ': Rename alias0 alias1 xs

463348

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−

469349-- | Check if a `TableConstraint` involves a column

470350type family ConstraintInvolves column constraint where

471351 ConstraintInvolves column ('Check columns) = column `Elem` columns

@@ -488,21 +368,11 @@ data SchemumType

488368 = Table TableType

489369 | View RowType

490370 | Typedef PGType

491− | Index IndexType

492− | Function FunctionType

371+ | Index

372+ | Function [NullityType] ReturnsType

493373 | Operator OperatorType

494374 | UnsafeSchemum Symbol

495375

496−type FunctionType = ([NullityType], ReturnsType)

497−

498−data IndexType

499− = Btree

500− | Hash

501− | Gist

502− | Spgist

503− | Gin

504− | Brin

505−

506376data ReturnsType

507377 = Returns NullityType

508378 | ReturnsTable RowType

squeal-postgresql/test/Property.hs+2−2

@@ -92,14 +92,14 @@ roundtrips = Group "roundtrips"

9292 -- genTimeWithZone = (,) <$> genTimeOfDay <*> genTimeZone

9393

9494roundtrip

95− :: (OidOf ty, ToParam x ty, FromValue ty x, Show x, Eq x)

95+ :: (ToParam x ty, FromValue ty x, Show x, Eq x)

9696 => TypeExpression schemas ('NotNull ty)

9797 -> Gen x

9898 -> (PropertyName, Property)

9999roundtrip = roundtripOn id

100100

101101roundtripOn

102− :: (OidOf ty, ToParam x ty, FromValue ty x, Show x, Eq x)

102+ :: (ToParam x ty, FromValue ty x, Show x, Eq x)

103103 => (x -> x)

104104 -> TypeExpression schemas ('NotNull ty)

105105 -> Gen x

squeal-postgresql/test/Spec.hs−11

@@ -123,14 +123,3 @@ spec = before_ setupDB . after_ dropDB $ do

123123 getRows =<< runQuery query

124124 (fromOnly <$> rangesOut :: [Range Int32]) `shouldBe`

125125 [ 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

stack.yaml+1−1

@@ -5,4 +5,4 @@ packages:

55extra-deps:

66- unliftio-pool-0.2.1.0

77- github: morphismtech/free-categories

8− commit: c0e555fbefb5c21619e532264c4dfeac556d0630

8+ commit: b28b4c0d2f56d447b5f81964d1313a5f7c1a0015