d7a0d1a · squeal · git.iko.soy

git.iko.soy/squeal

haddocks and ...

remove Entity for now rename alignedMap to mapAligned

commitd7a0d1a5a073ed41f99c35301c95f6dd414c4b81 authorEitan Chatav <eitan@Eitans-MacBook-Pro.local> dateFri 12 Apr 2019, 16:46 (8 years ago) parent880eb7f

7 files changed+92−65

compare with dev

unifiedsplit

squeal-postgresql/src/Squeal/PostgreSQL.hs+1−1 squeal-postgresql/src/Squeal/PostgreSQL/Alias.hs+14−1 squeal-postgresql/src/Squeal/PostgreSQL/List.hs+21−5 squeal-postgresql/src/Squeal/PostgreSQL/Migration.hs+2−2 squeal-postgresql/src/Squeal/PostgreSQL/PG.hs+49−52 squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+2−2 squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+3−2

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

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

11{-|

22Module: Squeal.PostgreSQL

33Description: Squeal export module

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

55Maintainer: eitan@morphism.tech

66Stability: experimental

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

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

1+{-|

2+Module: Squeal.PostgreSQL.Alias

3+Description: Aliases

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

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

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

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

11+-}

12+

113{-# LANGUAGE

214 AllowAmbiguousTypes

315 , ConstraintKinds

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

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

209221

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

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

223+to a `Squeal.PostgreSQL.Schema.Table`, `Squeal.PostgreSQL.Schema.Typedef`

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

212225a qualifier of @public@ is provided.

213226

214227>>> :{

squeal-postgresql/src/Squeal/PostgreSQL/List.hs+21−5

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

1+{-|

2+Module: Squeal.PostgreSQL.List

3+Description: List related types and functions

4+Copyright: (c) Eitan Chatav, 2019

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+Haskell singly-linked lists are very powerful. This module

9+provides functionality for type-level lists, heterogeneous

10+lists and type aligned lists.

11+-}

12+

113{-# LANGUAGE

214 DataKinds

315 , FlexibleContexts

@@ -24,7 +36,7 @@ module Squeal.PostgreSQL.List

2436 , AlignedList (..)

2537 , single

2638 , extractList

27− , alignedMap

39+ , mapAligned

2840 , Elem

2941 , In

3042 , Length

@@ -56,9 +68,11 @@ disjoin = case sList @xs of

5668 SCons -> \(x :* xsys) ->

5769 case disjoin xsys of (xs,ys) -> (x :* xs, ys)

5870

71+-- | The `Additionally` class is for appending

72+-- type-level list parameterized constructors such as `NP`,

73+-- `Squeal.PostgreSQL.Query.Selection`, and `Squeal.PostgreSQL.Query.FromClause`.

5974class Additionally expr where

6075 also :: expr ys -> expr xs -> expr (Join xs ys)

61−

6276instance Additionally (NP expr) where

6377 also ys = \case

6478 Nil -> ys

@@ -81,18 +95,20 @@ instance (forall t0 t1. RenderSQL (p t0 t1))

8195 step :>> Done -> renderSQL step

8296 step :>> steps -> renderSQL step <> ", " <> renderSQL steps

8397

98+-- | `extractList` turns an `AlignedList` into a standard list.

8499extractList :: (forall a0 a1. p a0 a1 -> b) -> AlignedList p x0 x1 -> [b]

85100extractList f = \case

86101 Done -> []

87102 step :>> steps -> (f step):extractList f steps

88103

89−alignedMap

104+-- | `mapAligned` applies a function to each element of an `AlignedList`.

105+mapAligned

90106 :: (forall z0 z1. p z0 z1 -> q z0 z1)

91107 -> AlignedList p x0 x1

92108 -> AlignedList q x0 x1

93−alignedMap f = \case

109+mapAligned f = \case

94110 Done -> Done

95− x :>> xs -> f x :>> alignedMap f xs

111+ x :>> xs -> f x :>> mapAligned f xs

96112

97113-- | A `single` step.

98114single :: p x0 x1 -> AlignedList p x0 x1

squeal-postgresql/src/Squeal/PostgreSQL/Migration.hs+2−2

@@ -205,8 +205,8 @@ class Category p => Migratory p where

205205 -> PQ schemas1 schemas0 IO ()

206206

207207instance Migratory Definition where

208− migrateUp = migrateUp . alignedMap pureMigration

209− migrateDown = migrateDown . alignedMap pureMigration

208+ migrateUp = migrateUp . mapAligned pureMigration

209+ migrateDown = migrateDown . mapAligned pureMigration

210210

211211{- | `Terminally` turns an indexed monad transformer and the monad it transforms

212212into a category by restricting the return type to @()@ and permuting the type variables.

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

@@ -1,4 +1,13 @@

1−

1+{-|

2+Module: Squeal.PostgreSQL.PG

3+Description: Embedding of Haskell types into Postgres's type system

4+Copyright: (c) Eitan Chatav, 2010

5+Maintainer: eitan@morphism.tech

6+Stability: experimental

8+`Squeal.PostgreSQL.PG` provides type families for turning Haskell

9+`Type`s into corresponding Postgres types.

10+-}

211{-# LANGUAGE

312 AllowAmbiguousTypes

413 , DeriveFoldable

@@ -28,7 +37,6 @@ module Squeal.PostgreSQL.PG

2837 , NullPG

2938 , TuplePG

3039 , RowPG

31− , Entity

3240 -- * Storage newtypes

3341 , Money (..)

3442 , Json (..)

@@ -45,7 +53,6 @@ module Squeal.PostgreSQL.PG

4553 , TupleOf

4654 , TupleCodeOf

4755 , RowOf

48− , ColumnsOf

4956 , ConstructorsOf

5057 , ConstructorNameOf

5158 , ConstructorNamesOf

@@ -91,30 +98,55 @@ PG LocalTime :: PGType

9198>>> type instance PG MyDouble = 'PGfloat8

9299-}

93100type family PG (hask :: Type) :: PGType

101+-- | `PGbool`

94102type instance PG Bool = 'PGbool

103+-- | `PGint2`

95104type instance PG Int16 = 'PGint2

105+-- | `PGint4`

96106type instance PG Int32 = 'PGint4

107+-- | `PGint8`

97108type instance PG Int64 = 'PGint8

109+-- | `PGint2`

98110type instance PG Word16 = 'PGint2

111+-- | `PGint4`

99112type instance PG Word32 = 'PGint4

113+-- | `PGint8`

100114type instance PG Word64 = 'PGint8

115+-- | `PGnumeric`

101116type instance PG Scientific = 'PGnumeric

117+-- | `PGfloat4`

102118type instance PG Float = 'PGfloat4

119+-- | `PGfloat8`

103120type instance PG Double = 'PGfloat8

121+-- | `PGchar` @1@

104122type instance PG Char = 'PGchar 1

123+-- | `PGtext`

105124type instance PG Strict.Text = 'PGtext

125+-- | `PGtext`

106126type instance PG Lazy.Text = 'PGtext

127+-- | `PGtext`

107128type instance PG String = 'PGtext

129+-- | `PGbytea`

108130type instance PG Strict.ByteString = 'PGbytea

131+-- | `PGbytea`

109132type instance PG Lazy.ByteString = 'PGbytea

133+-- | `PGtimestamp`

110134type instance PG LocalTime = 'PGtimestamp

135+-- | `PGtimestamptz`

111136type instance PG UTCTime = 'PGtimestamptz

137+-- | `PGdate`

112138type instance PG Day = 'PGdate

139+-- | `PGtime`

113140type instance PG TimeOfDay = 'PGtime

141+-- | `PGtimetz`

114142type instance PG (TimeOfDay, TimeZone) = 'PGtimetz

143+-- | `PGinterval`

115144type instance PG DiffTime = 'PGinterval

145+-- | `PGuuid`

116146type instance PG UUID = 'PGuuid

147+-- | `PGinet`

117148type instance PG (NetAddr IP) = 'PGinet

149+-- | `PGjson`

118150type instance PG Value = 'PGjson

119151

120152{-| The `LabelsPG` type family calculates the constructors of a

@@ -170,58 +202,11 @@ type family RowPG (hask :: Type) :: RowType where

170202 RowPG (SOP.P (col ::: ty)) = '[col ::: NullPG ty]

171203 RowPG hask = RowOf (SOP.RecordCodeOf hask)

172204

205+-- | `RowOf` applies `NullPG` to the fields of a list.

173206type family RowOf (record :: [(Symbol, Type)]) :: RowType where

174207 RowOf '[] = '[]

175208 RowOf (col ::: ty ': record) = col ::: NullPG ty ': RowOf record

176209

177−type family ColumnsOf (record :: [(Symbol, Type)]) :: ColumnsType where

178− ColumnsOf '[] = '[]

179− ColumnsOf (col ::: ty ': record) =

180− col ::: 'NoDef :=> NullPG ty ': ColumnsOf record

181−

182−{- |

183−`Entity` turns a Haskell `Type` into a `ColumnsType`.

184−

185−`Entity` may be applied to normal Haskell record types provided they

186−have the `SOP.Generic` and `SOP.HasDatatypeInfo` instances;

187−

188−>>> data Person = Person { name :: Strict.Text, age :: Int32 } deriving GHC.Generic

189−>>> instance SOP.Generic Person

190−>>> instance SOP.HasDatatypeInfo Person

191−>>> :kind! Entity Person

192−Entity Person :: [(Symbol, (ColumnConstraint, NullityType))]

193−= '["name" ::: ('NoDef :=> 'NotNull 'PGtext),

194− "age" ::: ('NoDef :=> 'NotNull 'PGint4)]

195−

196−Or to tuples of `SOP.P` types;

197−

198−>>> :kind! Entity (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32))

199−Entity (SOP.P ("id" ::: Int32), SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

200− ColumnType)]

201−= '[ '("id", 'Def :=> 'NotNull 'PGint4),

202− "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]

203−

204−Or to tuples which mix `SOP.P` types and record types.

205−

206−>>> :kind! Entity (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32))

207−Entity (SOP.P ("id" ::: Int32), Person, SOP.P ("foreign_id" ::: Int32)) :: [(Symbol,

208− ColumnType)]

209−= '[ '("id", 'Def :=> 'NotNull 'PGint4),

210− '("name", 'NoDef :=> 'NotNull 'PGtext),

211− '("age", 'NoDef :=> 'NotNull 'PGint4),

212− "foreign_id" ::: ('Def :=> 'NotNull 'PGint4)]

213−-}

214−type family Entity (hask :: Type) :: ColumnsType where

215− Entity (hask1, hask2) = Join (Entity hask1) (Entity hask2)

216− Entity (hask1, hask2, hask3) =

217− Join (Entity hask1) (Entity (hask2, hask3))

218− Entity (hask1, hask2, hask3, hask4) =

219− Join (Entity hask1) (Entity (hask2, hask3, hask4))

220− Entity (hask1, hask2, hask3, hask4, hask5) =

221− Join (Entity hask1) (Entity (hask2, hask3, hask4, hask5))

222− Entity (SOP.P (col ::: ty)) = '[col ::: 'Def :=> NullPG ty]

223− Entity hask = ColumnsOf (SOP.RecordCodeOf hask)

224−

225210{- | `NullPG` turns a Haskell type into a `NullityType`.

226211

227212>>> :kind! NullPG Double

@@ -245,10 +230,13 @@ TuplePG (Double, Maybe Char) :: [NullityType]

245230type family TuplePG (hask :: Type) :: [NullityType] where

246231 TuplePG hask = TupleOf (TupleCodeOf hask (SOP.Code hask))

247232

233+-- | `TupleOf` turns a list of Haskell `Type`s into a list of `NullityType`s.

248234type family TupleOf (tuple :: [Type]) :: [NullityType] where

249235 TupleOf '[] = '[]

250236 TupleOf (hask ': tuple) = NullPG hask ': TupleOf tuple

251237

238+-- | `TupleCodeOf` takes the `SOP.Code` of a haskell `Type`

239+-- and if it's a simple product returns it, otherwise giving a `TypeError`.

252240type family TupleCodeOf (hask :: Type) (code :: [[Type]]) :: [Type] where

253241 TupleCodeOf hask '[tuple] = tuple

254242 TupleCodeOf hask '[] =

@@ -289,6 +277,7 @@ type family ConstructorNamesOf (constructors :: [Type.ConstructorInfo])

289277 ConstructorNamesOf (constructor ': constructors) =

290278 ConstructorNameOf constructor ': ConstructorNamesOf constructors

291279

280+-- | `DimPG` turns Haskell nested homogeneous tuples into a list of lengths.

292281type family DimPG (hask :: Type) :: [Nat] where

293282 DimPG (x,x) = 2 ': DimPG x

294283 DimPG (x,x,x) = 3 ': DimPG x

@@ -301,6 +290,7 @@ type family DimPG (hask :: Type) :: [Nat] where

301290 DimPG (x,x,x,x,x,x,x,x,x,x) = 10 ': DimPG x

302291 DimPG x = '[]

303292

293+-- | `FixPG` extracts `NullPG` of the base type of nested homogeneous tuples.

304294type family FixPG (hask :: Type) :: NullityType where

305295 FixPG (x,x) = FixPG x

306296 FixPG (x,x,x) = FixPG x

@@ -339,6 +329,7 @@ True

339329-}

340330newtype Money = Money { cents :: Int64 }

341331 deriving (Eq, Ord, Show, Read, GHC.Generic)

332+-- | `PGmoney`

342333type instance PG Money = 'PGmoney

343334

344335{- | The `Json` newtype is an indication that the Haskell

@@ -346,6 +337,7 @@ type it's applied to should be stored as a `PGjson`.

346337-}

347338newtype Json hask = Json {getJson :: hask}

348339 deriving (Eq, Ord, Show, Read, GHC.Generic)

340+-- | `PGjson`

349341type instance PG (Json hask) = 'PGjson

350342

351343{- | The `Jsonb` newtype is an indication that the Haskell

@@ -353,6 +345,7 @@ type it's applied to should be stored as a `PGjsonb`.

353345-}

354346newtype Jsonb hask = Jsonb {getJsonb :: hask}

355347 deriving (Eq, Ord, Show, Read, GHC.Generic)

348+-- | `PGjsonb`

356349type instance PG (Jsonb hask) = 'PGjsonb

357350

358351{- | The `Composite` newtype is an indication that the Haskell

@@ -360,6 +353,7 @@ type it's applied to should be stored as a `PGcomposite`.

360353-}

361354newtype Composite record = Composite {getComposite :: record}

362355 deriving (Eq, Ord, Show, Read, GHC.Generic)

356+-- | `PGcomposite` @(@`RowPG` @hask)@

363357type instance PG (Composite hask) = 'PGcomposite (RowPG hask)

364358

365359{- | The `Enumerated` newtype is an indication that the Haskell

@@ -367,6 +361,7 @@ type it's applied to should be stored as a `PGenum`.

367361-}

368362newtype Enumerated enum = Enumerated {getEnumerated :: enum}

369363 deriving (Eq, Ord, Show, Read, GHC.Generic)

364+-- | `PGenum` @(@`LabelsPG` @hask)@

370365type instance PG (Enumerated hask) = 'PGenum (LabelsPG hask)

371366

372367{- | The `VarArray` newtype is an indication that the Haskell

@@ -374,6 +369,7 @@ type it's applied to should be stored as a `PGvararray`.

374369-}

375370newtype VarArray arr = VarArray {getVarArray :: arr}

376371 deriving (Eq, Ord, Show, Read, GHC.Generic)

372+-- | `PGvararray` @(@`NullPG` @hask)@

377373type instance PG (VarArray (Vector hask)) = 'PGvararray (NullPG hask)

378374

379375{- | The `FixArray` newtype is an indication that the Haskell

@@ -381,4 +377,5 @@ type it's applied to should be stored as a `PGfixarray`.

381377-}

382378newtype FixArray arr = FixArray {getFixArray :: arr}

383379 deriving (Eq, Ord, Show, Read, GHC.Generic)

384−type instance PG (FixArray x) = 'PGfixarray (DimPG x) (FixPG x)

380+-- | `PGfixarray` @(@`DimPG` @hask) (@`FixPG` @hask)@

381+type instance PG (FixArray hask) = 'PGfixarray (DimPG hask) (FixPG hask)

squeal-postgresql/src/Squeal/PostgreSQL/Query.hs+2−2

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

11{-|

22Module: Squeal.PostgreSQL.Query

33Description: Squeal queries

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

55Maintainer: eitan@morphism.tech

66Stability: experimental

@@ -723,7 +723,7 @@ table (tab `As` alias) = UnsafeFromClause $

723723subquery

724724 :: Aliased (Query outer commons schemas params) query

725725 -> FromClause outer commons schemas params '[query]

726−subquery = UnsafeFromClause . renderAliased (parenthesized . renderQuery)

726+subquery = UnsafeFromClause . renderAliased (parenthesized . renderSQL)

727727

728728-- | `view` derives a table from a `View`.

729729view

squeal-postgresql/src/Squeal/PostgreSQL/Schema.hs+3−2

@@ -1,11 +1,11 @@

11{-|

22Module: Squeal.PostgreSQL.Schema

33Description: Embedding of PostgreSQL type and alias system

4−Copyright: (c) Eitan Chatav, 2017

4+Copyright: (c) Eitan Chatav, 2019

55Maintainer: eitan@morphism.tech

66Stability: experimental

8−This module provides a type-level DSL for kinds of Postgres types,

8+`Squeal.PostgreSQL.Schema` provides a type-level DSL for kinds of Postgres types,

99tables, schema, constraints, aliases, enumerated labels, and groupings.

1010It also defines useful type families to operate on these. Finally,

1111it defines an embedding of Haskell types into Postgres types.

@@ -452,6 +452,7 @@ There are several reasons why one might want to use schemas:

452452-}

453453type SchemasType = [(Symbol,SchemaType)]

454454

455+-- | A type family to use for a single schema database.

455456type family Public (schema :: SchemaType) :: SchemasType

456457 where Public schema = '["public" ::: schema]

457458