on master help sign in
.github/workflows/build.yaml+3−3
since splitsnapshots
unifiedsplit
@@ -9,14 +9,14 @@ jobs:
9 persist-credentials: false
9 persist-credentials: false
10 submodules: true
10 submodules: true
11
11
12− - uses: cachix/install-nix-action@v12
12+ - uses: cachix/install-nix-action@v14.1
13 with:
13 with:
14 nix_path: nixpkgs=channel:nixos-unstable
14 nix_path: nixpkgs=channel:nixos-unstable
15 extra_nix_config: |
15 extra_nix_config: |
16 trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ=
16 trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ=
17− substituters = https://cache.nixos.org/ https://hydra.iohk.io
17+ substituters = https://cache.nixos.org/ https://cache.iog.io
18
18
19− - uses: cachix/cachix-action@v8
19+ - uses: cachix/cachix-action@v10
20 with:
20 with:
21 name: rel8
21 name: rel8
22 authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
22 authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
Changelog.mdnew file+159
@@ -0,0 +1,159 @@
1+# 1.4.0.0 (2002-08-17)
2+
3+## Breaking changes
4+
5+* The behavior of `greatest`/`least` has been corrected, and was previously flipped. ([#183](https://github.com/circuithub/rel8/pull/183))
6+
7+## New features
8+
9+* `NullTable`/`HNull` have been added. This is an alternative to `MaybeTable` that doesn't use a tag columns. It's less flexible (no `Functor` or `Applicative` instance) and is meaningless when used with a table that has no non-nullable columns (so nesting `NullTable` is redundant). But in situations where the underlying `Table` does have non-nullable columns, it can losslessly converted to and from `MaybeTable`. It is useful for embedding into a base table when you don't want to store the extra tag column in your schema. ([#173](https://github.com/circuithub/rel8/pull/173))
10+* Add `fromMaybeTable`. ([#179](https://github.com/circuithub/rel8/pull/179))
11+* Add `alignMaybeTable`. ([#196](https://github.com/circuithub/rel8/pull/196))
12+
13+## Improvements
14+
15+* Optimize implementation of `AltTable` for `Tabulation` ([#178](https://github.com/circuithub/rel8/pull/178))
16+
17+## Other
18+
19+* Documentation improvements for `HADT`. ([#177](https://github.com/circuithub/rel8/pull/177))
20+* Document example usage of `groupBy`. ([#184](https://github.com/circuithub/rel8/pull/184))
21+* Build with and require Opaleye >= 0.9.3.3. ([#190](https://github.com/circuithub/rel8/pull/190))
22+* Build with `hasql` 1.6. ([#195](https://github.com/circuithub/rel8/pull/195))
23+
24+# 1.3.1.0 (2022-01-20)
25+
26+## Other
27+
28+* Rel8 now requires Opaleye >= 0.9.1. ([#165](https://github.com/circuithub/rel8/pull/165))
29+
30+# 1.3.0.0 (2022-01-31)
31+
32+## Breaking changes
33+
34+* `div` and `mod` have been changed to match Haskell semantics. If you need the PostgreSQL `div()` and `mod()` functions, use `quot` and `rem`. While this is not an API change, we feel this is a breaking change in semantics and have bumped the major version number. ([#155](https://github.com/circuithub/rel8/pull/155))
35+
36+## New features
37+
38+* `divMod` and `quotRem` functions have been added, matching Haskell's `Prelude` functions. ([#155](https://github.com/circuithub/rel8/pull/155))
39+* `avg` and `mode` aggregation functions to find the mean value of an expression, or the most common row in a query, respectively. ([#152](https://github.com/circuithub/rel8/pull/152))
40+* The full `EqTable` and `OrdTable` classes have been exported, allowing for instances to be manually created. ([#157](https://github.com/circuithub/rel8/pull/157))
41+* Added `like` and `ilike` (for the `LIKE` and `ILIKE` operators). ([#146](https://github.com/circuithub/rel8/pull/146))
42+
43+## Other
44+
45+* Rel8 now requires Opaleye 0.9. ([#158](https://github.com/circuithub/rel8/pull/158))
46+* Rel8's test suite supports Hedgehog 1.1. ([#160](https://github.com/circuithub/rel8/pull/160))
47+* The documentation for binary operations has been corrected. ([#162](https://github.com/circuithub/rel8/pull/162))
48+
49+# 1.2.2.0 (2021-11-21)
50+
51+## Other
52+
53+* Support GHC 9.2 ([#145](https://github.com/circuithub/rel8/pull/145))
54+* Correct the documentation for `except` ([#147](https://github.com/circuithub/rel8/pull/147))
55+* Support `hasql` 1.5 ([#149](https://github.com/circuithub/rel8/pull/149))
56+
57+# 1.2.1.0 (2021-11-21)
58+
59+## New features
60+
61+* `castTable` has been added, which casts all columns selected from in `Query` according to the types of columns. This can occasionally be useful when using `many`/`some` on older PostgreSQL versions. ([#137](https://github.com/circuithub/rel8/pull/137))
62+
63+* Added `<:`, `<=:`, `>:`, `>=:`, `greatest` and `least`, which sort all columns in a table lexicographically. These operators are like the `<.` operators which operate on `Expr`s, but the `<:` operate on entire tables. ([#139](https://github.com/circuithub/rel8/pull/139))
64+
65+## Other
66+
67+* Support opaleye-0.8 ([#142](https://github.com/circuithub/rel8/pull/142))
68+
69+# 1.2.0.0 (2021-10-22)
70+
71+## New features
72+
73+* New `$*` and `$+` operators for projecting out of `ListTable` and `NonEmptyTable` respectively (analogous to the existing `$?` for `MaybeTable`). ([#125](https://github.com/circuithub/rel8/pull/125))
74+
75+## Bug fixes
76+
77+* Fix `UPSERT` support (and add tests), which was broken due to a typo inside Rel8 that made it impossible to construct `Projection`s which are needed by `UPSERT`. ([#134](https://github.com/circuithub/rel8/pull/134))
78+
79+* Remove `DBMin` and `DBMax` instances for `Bool`, which are invalid as far as Postgres is concerned. `and` and `or` can be used to achieve the same thing. ([#126](https://github.com/circuithub/rel8/pull/126))
80+
81+* Fix `aggregateMaybeTable`, `aggregateEitherTable` and `aggregateTheseTable`, which generated invalid SQL previously. ([#127](https://github.com/circuithub/rel8/pull/127))
82+
83+## Breaking changes
84+
85+* `rebind` now takes an additional argument for the "name" of the binding. ([#128](https://github.com/circuithub/rel8/pull/128))
86+
87+# 1.1.0.0 (2021-07-16)
88+
89+## New features
90+
91+* You can derive `Rel8able` for "vanilla" higher-kinded data types - data types that don't use the `Column` type family. For example, the following is now possible:
92+
93+ ```haskell
94+ data MyTable f = MyTable
95+ { myTableX :: f Int32
96+ , myTableY :: f Text
97+ } deriving (Generic, Rel8able)
98+ ```
99+
100+* The `Projectable` and `Biprojectable` type classes have been introduced. These classes model a type of functors and bifunctors (respectively) on tables, where the mapping function is only able to rearrange columns. For example, the following is now possible:
101+
102+ ```haskell
103+ x <- project myTableX <$> many ...
104+ ```
105+
106+* `Insert`'s `onConflict` field now has a new option - `DoUpdate`. This maps to PostgreSQL's `ON CONFLICT DO UPDATE` syntax, which provides upsert support. ([#85](https://github.com/circuithub/rel8/pull/85))
107+
108+* `Insert`, `Update` and `Delete` has all been expanded to work with `Query`s. In particular:
109+
110+ * `Delete` now supports a `USING` sub-query
111+ * `Update` now supports a `FROM` sub-query
112+ * `Insert` can delete the result of any arbitrary `Query` (providing the types match)
113+
114+* The new `Rel8.Tabulate` module has been added, which gives a `Map`-esque interface to writing and composing queries. ([#70](https://github.com/circuithub/rel8/pull/70))
115+
116+* The new `indexed` `Query -> Query` function was added. This function augments each row in a query with it's 0-based index. ([#117](https://github.com/circuithub/rel8/pull/117))
117+
118+## Breaking changes
119+
120+* `Insert`, `Delete` and `Update` have all changed. In particular, for `Insert` users should now replace `rows = xs` with `rows = values xs`. ([#85](https://github.com/circuithub/rel8/pull/85))
121+
122+* Rename `whereExists` and `whereNotExists` to `present` and `absent` respectively. ([#57](https://github.com/circuithub/rel8/pull/57))
123+
124+* Simplify `evaluate` to run directly inside the `Query` monad, rendering the `Evaluate` monad unnecessary. ([#56](https://github.com/circuithub/rel8/pull/56))
125+
126+* The `Labelable` type class has been removed as it's no longer necessary. This class was mostly internal, though was visible in some public API functions. ([#76](https://github.com/circuithub/rel8/pull/76))
127+
128+* `EitherTable`, `ListTable`, `MaybeTable`, `NonEmptyTable` and `TheseTable` now all have an extra parameter which tracks the context of the table. If you manually specified any types before, you need to provide this parameter - usually `Expr` will be the correct choice. ([#101](https://github.com/circuithub/rel8/pull/101))
129+
130+* We've done a lot of work to simplify the internals of Rel8, but some of these are breaking changes. However, most of these API changes shouldn't affect users as they are mostly types used in type inference, or affect classes where users don't need to define their own instances.
131+
132+ * The kind of a `Rel8able` is now `(Type -> Type) -> Type`. Previously it was `(X -> Type) -> Type`.
133+ * `Table` has a new associated type - `FromExprs`. This was previously an open type family.
134+ * `Table` has a new associated type - `Transpose` - and `Recontextualise` has been renamed to `Transposes`. This `Transposes` class now operates in terms of `Transpose`.
135+
136+* `select`, `insert`, `update` and `delete` now produce Hasql `Statement`s, rather than actually running the statement as IO. This allows Rel8 to be used with transaction/connection-managing monads like [`hasql-transaction`](https://hackage.haskell.org/package/hasql-transaction). ([#94](https://github.com/circuithub/rel8/pull/94))
137+
138+## Bug fixes
139+
140+* Fixes a bug where cartesian products of queries using `catListTable`, `catNonEmptyTable`, `catList` and `catNonEmpty` would incorrectly be zipped instead. ([#61](https://github.com/circuithub/rel8/pull/61))
141+
142+* Require Opaleye 0.7.3.0. This version has better support for lateral queries, which can improve query plans, especially in `optional`/`LEFT JOIN` ([#72](https://github.com/circuithub/rel8/pull/72))
143+
144+* Rel8 now compiles with GHC 9. ([#97](https://github.com/circuithub/rel8/pull/97))
145+
146+## Other changes
147+
148+* `exists` is now implemented in terms of the SQL `EXISTS` keyword. ([#69](https://github.com/circuithub/rel8/pull/69))
149+
150+* `alignBy` no longer requires `Table`s. ([#67](https://github.com/circuithub/rel8/pull/67))
151+
152+
153+# 1.0.0.1 (2021-06-21)
154+
155+This release contains various fixes for documentation.
156+
157+# 1.0.0.0 (2021-06-18)
158+
159+* Initial release.
LICENSE+1−1
@@ -1,4 +1,4 @@
1−Copyright 2020 Oliver Charles
1+Copyright 2021 Oliver Charles
2
2
3All rights reserved.
3All rights reserved.
4
4
README.md+4
@@ -10,4 +10,8 @@ The main objectives of Rel8 are:
10
10
11* *Familiar*: writing Rel8 queries should feel like normal Haskell programming.
11* *Familiar*: writing Rel8 queries should feel like normal Haskell programming.
12
12
13+Rel8 was presented at ZuriHac 2021. If you want to have a brief overview of what Rel8 is, and a tour of the API - check out the video below:
14+
15+[![Rel8 presentation at ZuriHac 2021](https://img.youtube.com/vi/3uwrtjxiq6E/hqdefault.jpg)](http://www.youtube.com/watch?v=3uwrtjxiq6E)
16+
13For more details, check out the [official documentation](https://rel8.readthedocs.io/en/latest/).
17For more details, check out the [official documentation](https://rel8.readthedocs.io/en/latest/).
cabal.project−5
@@ -1,6 +1 @@
1packages: .
1packages: .
2−
3−allow-newer: generic-monoid:base
4−allow-newer: cryptohash-sha1:base
5−allow-newer: cryptohash-md5:base
6−allow-newer: entropy:Cabal
cabal.project.haskell-nix−6
@@ -2,9 +2,3 @@
2-- will interpret them as local packages, and try to build them when we cabal
2-- will interpret them as local packages, and try to build them when we cabal
3-- build. The only reason we have to specify these is for Haskell.nix to know to
3-- build. The only reason we have to specify these is for Haskell.nix to know to
4-- override these packages by fetching them rather than using Hackage.
4-- override these packages by fetching them rather than using Hackage.
5−
6−source-repository-package
7− type: git
8− location: git://github.com/jcpetruzza/barbies
9− tag: f99b05454874192e3511bd133555dfb6cc6a6ecb
10− --sha256: 0yy2i2jbllwavv5d2176rf8lmm4l1ws90lxkmdlfgvfzqxidx0gi
default.nix+5−5
@@ -1,15 +1,15 @@
1−let
1+let
2 haskellNix = import (import ./nix/sources.nix)."haskell.nix" {};
2 haskellNix = import (import ./nix/sources.nix)."haskell.nix" {};
3
3
4− nixpkgsSrc = haskellNix.sources.nixpkgs-2009;
4+ nixpkgsSrc = haskellNix.sources.nixpkgs-unstable;
5
5
6 nixpkgsArgs = haskellNix.nixpkgsArgs;
6 nixpkgsArgs = haskellNix.nixpkgsArgs;
7
7
8− compiler-nix-name = "ghc8104";
8+ compiler-nix-name = "ghc924";
9
9
10 pkgs = import nixpkgsSrc nixpkgsArgs;
10 pkgs = import nixpkgsSrc nixpkgsArgs;
11
11
12−in
12+in
13pkgs.haskell-nix.project {
13pkgs.haskell-nix.project {
14 inherit compiler-nix-name;
14 inherit compiler-nix-name;
15
15
@@ -20,7 +20,7 @@ pkgs.haskell-nix.project {
20 src = ./.;
20 src = ./.;
21 };
21 };
22
22
23− modules = [
23+ modules = [
24 { packages.rel8 = {
24 { packages.rel8 = {
25 preCheck = ''
25 preCheck = ''
26 export PATH="${pkgs.postgresql}/bin:${"$PATH"}"
26 export PATH="${pkgs.postgresql}/bin:${"$PATH"}"
docs/concepts/dbtype.rst+18−17
@@ -11,18 +11,19 @@ though most of these primitive ``DBType``\s should already be available.
11Combining ``newtype`` and ``DBType``
11Combining ``newtype`` and ``DBType``
12------------------------------------
12------------------------------------
13
13
14−You can define new instances of ``DBType`` by using Haskell "generalized newtype
14+You can define new instances of ``DBType`` by using Haskell "generalized
15−deriving" strategy. This is useful when you have a common database type, but
15+newtype deriving" strategy. This is useful when you have a common database
16−need to interpret this type differently in different contexts. A very common
16+type, but need to interpret this type differently in different contexts. A very
17−example here is with auto-incrementing ``id`` counters. In PostgreSQL, it's
17+common example here is with auto-incrementing ``id`` counters. In PostgreSQL,
18−common for a table to have a primary key that uses the ``serial`` type, which
18+it's common for a table to have a primary key that uses the ``serial`` type,
19−means the key is an ``int8`` with a default value for ``INSERT``. In Rel8, we
19+which means the key is an ``int8`` with a default value for ``INSERT``. In
20−could use ``Int64`` (as ``Int64`` is the ``DBType`` instance for ``int8``), but
20+Rel8, we could use ``Int64`` (as ``Int64`` is the ``DBType`` instance for
21−we can be even clearer if we make a ``newtype`` for each *type* of id.
21+``int8``), but we can be even clearer if we make a ``newtype`` for each *type*
22−
22+of id.
23+
23−If our database has users and orders, these tables might both have ids, but they
24+If our database has users and orders, these tables might both have ids, but
24−are clearly not meant to be treated as a common type. Instead, we can make these
25+they are clearly not meant to be treated as a common type. Instead, we can make
25−types clearly different by writing::
26+these types clearly different by writing::
26
27
27 newtype UserId = UserId { getUserId :: Int64 }
28 newtype UserId = UserId { getUserId :: Int64 }
28 deriving newtype DBType
29 deriving newtype DBType
@@ -57,8 +58,8 @@ In our PostgreSQL we have a few choices, but for now we'll assume that they are
57stored as ``text`` values.
58stored as ``text`` values.
58
59
59In order to use this type in Rel8 queries, we need to write an instance of
60In order to use this type in Rel8 queries, we need to write an instance of
60−``DBType`` for ``OrderStatus``. One approach is to use ``parseTypeInformation``,
61+``DBType`` for ``OrderStatus``. One approach is to use
61−which allows you to refine an existing ``DBType``::
62+``parseTypeInformation``, which allows you to refine an existing ``DBType``::
62
63
63 instance DBType OrderStatus where
64 instance DBType OrderStatus where
64 typeInformation = parseTypeInformation parser printer typeInformation
65 typeInformation = parseTypeInformation parser printer typeInformation
@@ -100,9 +101,9 @@ There usage is very similar to ``ReadShow`` - simply derive ``DBType via
100JSONEncoded``, and Rel8 will use ``ToJSON`` and ``FromJSON`` instances (from
101JSONEncoded``, and Rel8 will use ``ToJSON`` and ``FromJSON`` instances (from
101``aeson``) to serialize the given type.
102``aeson``) to serialize the given type.
102
103
103−For example, a project might use event sourcing with a table of events. Each row
104+For example, a project might use event sourcing with a table of events. Each
104−in this table is an event, but this event is stored as a JSON object. We can use
105+row in this table is an event, but this event is stored as a JSON object. We
105−this type with Rel8 by writing::
106+can use this type with Rel8 by writing::
106
107
107 data Event = UserCreated UserCreatedData | OrderCreated OrderCreatedData
108 data Event = UserCreated UserCreatedData | OrderCreated OrderCreatedData
108 deriving stock Generic
109 deriving stock Generic
docs/concepts/expr.rst+2−2
@@ -58,7 +58,7 @@ Through the API reference documentation for Rel8, you might encounter the
58``Sql`` type class. For example, if we look at the type of ``litExpr``, we
58``Sql`` type class. For example, if we look at the type of ``litExpr``, we
59have::
59have::
60
60
61− litExpr :: Sql DBType a => a -> Expr a
61+ litExpr :: Sql DBType a => a -> Expr a
62
62
63Here ``Sql DBType a`` means that ``a`` can either be literally a type that has
63Here ``Sql DBType a`` means that ``a`` can either be literally a type that has
64an instance of ``DBType`` (like ``UserId`` or ``Bool``), *or* that same type
64an instance of ``DBType`` (like ``UserId`` or ``Bool``), *or* that same type
@@ -69,6 +69,6 @@ Some functions work regardless of whether or not a value is null, and in these
69cases you'll see ``Sql DBType a``. ``Sql`` can be used with any ``DBType``
69cases you'll see ``Sql DBType a``. ``Sql`` can be used with any ``DBType``
70subtype. For example, the type of ``div`` is::
70subtype. For example, the type of ``div`` is::
71
71
72− div :: Sql DBIntegral a => Expr a -> Expr a -> Expr a
72+ div :: Sql DBIntegral a => Expr a -> Expr a -> Expr a
73
73
74Which means ``div`` works on any ``DBIntegral a``, including ``Maybe a``.
74Which means ``div`` works on any ``DBIntegral a``, including ``Maybe a``.
docs/concepts/insert.rstnew file+181
@@ -0,0 +1,181 @@
1+``INSERT``, ``UPDATE`` and ``DELETE``
2+=====================================
3+
4+While the majority of Rel8 is about building and executing ``SELECT``
5+statement, Rel8 also has support for ``INSERT``, ``UPDATE`` and ``DELETE``.
6+These statements are all executed using the ``insert``, ``update`` and
7+``delete`` functions, all of which take a record of parameters.
8+
9+.. note::
10+
11+ This part of Rel8's API uses the ``DuplicateRecordFields`` language
12+ extension. In code that needs to use this API, you should also enable this
13+ language extension, or you may get errors about ambiguous field names.
14+
15+``DELETE``
16+----------
17+
18+To perform a ``DELETE`` statement, construct a ``Delete`` value and execute it
19+using ``delete``. ``Delete`` takes:
20+
21+``from``
22+ The ``TableSchema`` for the table to delete rows from.
23+
24+``using``
25+ This is a simple ``Query`` that forms the ``USING`` clause of the ``DELETE``
26+ statement. This can be used to join against other tables, and the results
27+ can be referenced in the ``deleteWhere`` parameter. For simple ``DELETE``\s
28+ where you don't need to do this, you can set ``using = pure ()``.
29+
30+``deleteWhere``
31+ The ``WHERE`` clause of the ``DELETE`` statement. This is a function that
32+ takes two inputs: the result of the ``using`` query, and the current value
33+ of the row.
34+
35+``returning``
36+ What to return - see :ref:`returning`.
37+
38+``UPDATE``
39+----------
40+
41+To perform a ``UPDATE`` statement, construct a ``Update`` value and execute it
42+using ``update``. ``Update`` takes:
43+
44+``target``
45+ The ``TableSchema`` for the table to update rows in.
46+
47+``from``
48+ This is a simple ``Query`` that forms the ``FROM`` clause of the ``UPDATE``
49+ statement. This can be used to join against other tables, and the results
50+ can be referenced in the ``set`` and ``updateWhere`` parameters. For simple
51+ ``UPDATE``\s where you don't need to do this, you can set ``from = pure ()``.
52+
53+``set``
54+ A row to row transformation function, indicating how to update selected rows.
55+ This function takes rows of the same shape as ``target`` but in the ``Expr``
56+ context. One way to write this function is to use record update syntax::
57+
58+ set = \from row -> row { rowName = "new name" }
59+
60+``updateWhere``
61+ The ``WHERE`` clause of the ``UPDATE`` statement. This is a function that
62+ takes two inputs: the result of the ``from`` query, and the current value of
63+ the row.
64+
65+``returning``
66+ What to return - see :ref:`returning`.
67+
68+``INSERT``
69+----------
70+
71+To perform a ``INSERT`` statement, construct a ``Insert`` value and execute it
72+using ``insert``. ``Insert`` takes:
73+
74+``into``
75+ The ``TableSchema`` for the table to insert rows into.
76+
77+``rows``
78+ The rows to insert. These are the same as ``into``, but in the ``Expr``
79+ context. You can construct rows from their individual fields::
80+
81+ rows = values [ MyTable { myTableA = lit "A", myTableB = lit 42 }
82+
83+ or you can use ``lit`` on a table value in the ``Result`` context::
84+
85+ rows = values [ lit MyTable { myTableA = "A", myTableB = 42 }
86+
87+``onConflict``
88+ What should happen if an insert clashes with rows that already exist. This
89+ corresponds to PostgreSQL's ``ON CONFLICT`` clause. You can specify:
90+
91+ ``Abort``
92+ PostgreSQL should abort the ``INSERT`` with an exception
93+
94+ ``DoNothing``
95+ PostgreSQL should not insert the duplicate rows.
96+
97+ ``DoUpdate``
98+ PostgreSQL should instead try to update any existing rows that conflict
99+ with rows proposed for insertion.
100+
101+``returning``
102+ What to return - see :ref:`returning`.
103+
104+.. _returning:
105+
106+``RETURNING``
107+-------------
108+
109+PostgreSQL has the ability to return extra information after a ``DELETE``,
110+``INSERT`` or ``UPDATE`` statement by attaching a ``RETURNING`` clause. A common
111+use of this clause is to return any automatically generated sequence values for
112+primary key columns. Rel8 supports ``RETURNING`` clauses by filling in the
113+``returning`` field and specifying a ``Projection``. A ``Projection`` is a row
114+to row transformation, allowing you to project out a subset of fields.
115+
116+For example, if we are inserting orders, we might want the order ids returned::
117+
118+ insert Insert
119+ { into = orderSchema
120+ , rows = values [ order ]
121+ , onConflict = Abort
122+ , returning = Projection orderId
123+ }
124+
125+If we don't want to return anything, we can use ``pure ()``::
126+
127+ insert Insert
128+ { into = orderSchema
129+ , rows = values [ order ]
130+ , onConflict = Abort
131+ , returning = pure ()
132+ }
133+
134+Default values
135+--------------
136+
137+It is fairly common to define tables with default values. While Rel8 does not
138+have specific functionality for ``DEFAULT``, there are a few options:
139+
140+``unsafeDefault``
141+~~~~~~~~~~~~~~~~~~~~~~~~~~~
142+
143+Rel8 does not have any special support for ``DEFAULT``. If you need to use
144+default column values in inserts, you can use ``unsafeDefault`` to
145+construct the ``DEFAULT`` expression::
146+
147+ insert Insert
148+ { into = orderSchema
149+ , rows = values [ Order { orderId = unsafeDefault, ... } ]
150+ , onConflict = Abort
151+ , returning = Projection orderId
152+ }
153+
154+.. warning::
155+ As the name suggests, this is an unsafe operation. In particular, Rel8 is not
156+ able to prove that this column does have a default value, so it may be
157+ possible to introduce a runtime error. Furthermore, ``DEFAULT`` is fairly
158+ special in SQL, and cannot be combined like other expressions. For example,
159+ the innocuous expression::
160+
161+ unsafeDefault + 1
162+
163+ will lead to a runtime crash.
164+
165+Reimplement default values in Rel8
166+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
167+
168+If you only need to access default values in Rel8, another option is to specify
169+them in Rel8, rather than in your database schema.
170+
171+.. hint::
172+ A common default value for primary keys is to use `nextval` to obtain the
173+ next value from a sequence. This can be done in Rel8 by using the ``nextval``
174+ function::
175+
176+ insert Insert
177+ { into = orderSchema
178+ , rows = values [ Order { orderId = nextval "order_id_seq", ... } ]
179+ , onConflict = Abort
180+ , returning = Projection orderId
181+ }
docs/concepts/queries.rst+9−9
@@ -88,7 +88,7 @@ notation allows you to write these queries in a simpler form, where we don't
88have to introduce functions. Expanding on the latter query, we could write::
88have to introduce functions. Expanding on the latter query, we could write::
89
89
90 do user <- getAllUsers
90 do user <- getAllUsers
91− order <- getOrdersForUser (user)
91+ order <- getOrdersForUser user
92 return (user, order)
92 return (user, order)
93
93
94Now we have a query that, for each ``User``, fetches all orders for that user.
94Now we have a query that, for each ``User``, fetches all orders for that user.
@@ -138,20 +138,20 @@ a query. The above query could thus be written as::
138
138
139``where_`` and ``filter`` allow you to filter rows based on an expression, but
139``where_`` and ``filter`` allow you to filter rows based on an expression, but
140sometimes we want to filter based on another query. For this, Rel8 offers
140sometimes we want to filter based on another query. For this, Rel8 offers
141−``whereExists`` and ``whereNotExists``. For example, if all blog posts have a
141+``present`` and ``absent``. For example, if all blog posts have a
142−list of tags, we could use ``whereExists`` to find all blog posts that have been
142+list of tags, we could use ``present`` to find all blog posts that have been
143tagged as "Haskell"::
143tagged as "Haskell"::
144
144
145 blogPost <- each blogPostSchema
145 blogPost <- each blogPostSchema
146− whereExists do
146+ present do
147 filter (("Haskell" ==.) . tagName) =<< tagFromBlogPost blogPost
147 filter (("Haskell" ==.) . tagName) =<< tagFromBlogPost blogPost
148
148
149−Notice that this example uses ``whereExists`` with a query that itself uses
149+Notice that this example uses ``present`` with a query that itself uses
150−``filter``. For each blog post, ``whereExists`` causes that row to be selected
150+``filter``. For each blog post, ``present`` causes that row to be selected
151only if the associated query finds a tag for that blog post with the ``tagName``
151only if the associated query finds a tag for that blog post with the ``tagName``
152"Haskell".
152"Haskell".
153
153
154−Like ``filter`` there is also a chaining variant of ``whereExists`` - ``with``.
154+Like ``filter`` there is also a chaining variant of ``present`` - ``with``.
155We could rewrite the above query using ``with`` as::
155We could rewrite the above query using ``with`` as::
156
156
157 haskellBlogPost <-
157 haskellBlogPost <-
@@ -194,11 +194,11 @@ and this query can be written in Rel8 as::
194
194
195 authorForBlogPost :: BlogPost Expr -> Query (Author Expr)
195 authorForBlogPost :: BlogPost Expr -> Query (Author Expr)
196 authorForBlogPost blogPost =
196 authorForBlogPost blogPost =
197− filter ((blogPostAuthorId blogPost ==.) authorId author) =<<
197+ filter ((blogPostAuthorId blogPost ==.) . authorId) =<<
198 each authorSchema
198 each authorSchema
199
199
200 While this is a little more code over all, in our experience this style
200 While this is a little more code over all, in our experience this style
201− dramatically increases the readabality of queries using joins.
201+ dramatically increases the readability of queries using joins.
202
202
203Left (outer) joins with ``optional``
203Left (outer) joins with ``optional``
204------------------------------------
204------------------------------------
docs/cookbook.rst+10−8
@@ -72,7 +72,7 @@ can be written as::
72 each myTableSchema
72 each myTableSchema
73
73
74Note that we use ``>$<`` (from ``Data.Functor.Contravariant``) to select table
74Note that we use ``>$<`` (from ``Data.Functor.Contravariant``) to select table
75−columns, and we can use `mconcat` to combine orderings.
75+columns, and we can use ``mconcat`` to combine orderings.
76
76
77If all columns of a table have an ordering, you can also use ``ascTable`` and
77If all columns of a table have an ordering, you can also use ``ascTable`` and
78``descTable``. For example::
78``descTable``. For example::
@@ -142,23 +142,25 @@ rows, but can also return *tree*\s.
142To understand what this means, we'll consider a small example query for blog
142To understand what this means, we'll consider a small example query for blog
143posts. We want our query to return:
143posts. We want our query to return:
144
144
145−1. The latest 5 blog posts.
145+1. The latest 5 blog posts that have at least one tag each.
1462. For each blog post, all tags.
1462. For each blog post, all tags.
147−3. For each blog post, the latest 3 comments.
147+3. For each blog post, the latest 3 comments if they exist.
148
148
149In Rel8, we can write this query as::
149In Rel8, we can write this query as::
150
150
151 latestBlogPosts = do
151 latestBlogPosts = do
152 post <- each postSchema
152 post <- each postSchema
153
153
154+ -- Returns a `NonEmptyTable a` which ends up as a `Data.List.NonEmpty a` after the query is run
154− tags <- aggregate do
155+ tags <- some $ do
155 tag <- each tagSchema
156 tag <- each tagSchema
156 where_ (tagPostId tag ==. postId post)
157 where_ (tagPostId tag ==. postId post)
157− return (listAgg (tagName tag))
158+ return (tagName tag)
158
159
160+ -- Returns a `ListTable a` which ends up as a `[a]` after the query is run
159− latestComments <-
161+ latestComments <-
160− many $
162+ many $
161− limit 3 $
163+ limit 3 $
162 orderBy (commentCreatedAt >$< desc) do
164 orderBy (commentCreatedAt >$< desc) do
163 comment <- each commentSchema
165 comment <- each commentSchema
164 where_ (commentPostId comment ==. postId post)
166 where_ (commentPostId comment ==. postId post)
docs/index.rst+2−1
@@ -30,6 +30,7 @@ The main objectives of Rel8 are:
30 concepts/expr
30 concepts/expr
31 concepts/tables
31 concepts/tables
32 concepts/queries
32 concepts/queries
33+ concepts/insert
33
34
34.. toctree::
35.. toctree::
35 :caption: Tips and tricks
36 :caption: Tips and tricks
@@ -49,4 +50,4 @@ More Resources
49
50
50* If you think you've found a bug, confusing behavior, or have a feature
51* If you think you've found a bug, confusing behavior, or have a feature
51 request, please raise an issue at `Rel8's issue tracker
52 request, please raise an issue at `Rel8's issue tracker
52− <https://github.com/circuithub/rel8>`_.
53+ <https://github.com/circuithub/rel8>`_.
docs/tutorial.rst+64−47
@@ -5,24 +5,25 @@ Getting Started
5
5
6In this section, we'll take a look at using Rel8 to work with a small database
6In this section, we'll take a look at using Rel8 to work with a small database
7for Haskell packages. We'll take a look at idiomatic usage of Rel8, mapping
7for Haskell packages. We'll take a look at idiomatic usage of Rel8, mapping
8−tables to Haskell, and then look at writing some simple queries.
8+tables to Haskell, and then look at writing some simple queries.
9
9
10Before we get started, we'll be using the following language extensions and
10Before we get started, we'll be using the following language extensions and
11imports throughout this guide::
11imports throughout this guide::
12
12
13− {-# language -XBlockArguments #-}
13+ {-# language BlockArguments #-}
14− {-# language -XDeriveAnyClass #-}
14+ {-# language DeriveAnyClass #-}
15− {-# language -XDeriveGeneric #-}
15+ {-# language DeriveGeneric #-}
16− {-# language -XDerivingStrategies #-}
16+ {-# language DerivingStrategies #-}
17− {-# language -XDerivingVia #-}
17+ {-# language DerivingVia #-}
18− {-# language -XDuplicateRecordFields #-}
18+ {-# language DuplicateRecordFields #-}
19− {-# language -XGeneralizedNewtypeDeriving #-}
19+ {-# language GeneralizedNewtypeDeriving #-}
20− {-# language -XOverloadedStrings #-}
20+ {-# language OverloadedStrings #-}
21− {-# language -XStandaloneDeriving #-}
21+ {-# language StandaloneDeriving #-}
22− {-# language -XTypeApplications #-}
22+ {-# language TypeApplications #-}
23− {-# language -XTypeFamilies #-}
23+ {-# language TypeFamilies #-}
24
24
25 import Prelude
25 import Prelude
26+ import Rel8
26
27
27The Example Schema
28The Example Schema
28------------------
29------------------
@@ -70,7 +71,7 @@ Following these steps for ``author``, we have::
70 { authorId :: Column f Int64
71 { authorId :: Column f Int64
71 , name :: Column f Text
72 , name :: Column f Text
72 , url :: Column f (Maybe Text)
73 , url :: Column f (Maybe Text)
73− }
74+ }
74 deriving stock (Generic)
75 deriving stock (Generic)
75 deriving anyclass (Rel8able)
76 deriving anyclass (Rel8able)
76
77
@@ -81,7 +82,7 @@ in our project, it would be too easy to accidentally mix them up and create
81nonsensical joins. As Haskell programmers, we often solve this problem by
82nonsensical joins. As Haskell programmers, we often solve this problem by
82creating ``newtype`` wrappers, and we can also use this technique with Rel8::
83creating ``newtype`` wrappers, and we can also use this technique with Rel8::
83
84
84− newtype AuthorId = AuthorId { toInt64 :: Int64 }
85+ newtype AuthorId = AuthorId { toInt64 :: Int64 }
85 deriving newtype (DBEq, DBType, Eq, Show)
86 deriving newtype (DBEq, DBType, Eq, Show)
86
87
87Now we can write our final schema mapping. First, the ``author`` table::
88Now we can write our final schema mapping. First, the ``author`` table::
@@ -90,7 +91,7 @@ Now we can write our final schema mapping. First, the ``author`` table::
90 { authorId :: Column f AuthorId
91 { authorId :: Column f AuthorId
91 , authorName :: Column f Text
92 , authorName :: Column f Text
92 , authorUrl :: Column f (Maybe Text)
93 , authorUrl :: Column f (Maybe Text)
93− }
94+ }
94 deriving stock (Generic)
95 deriving stock (Generic)
95 deriving anyclass (Rel8able)
96 deriving anyclass (Rel8able)
96
97
@@ -99,16 +100,16 @@ And similarly, the ``project`` table::
99 data Project f = Project
100 data Project f = Project
100 { projectAuthorId :: Column f AuthorId
101 { projectAuthorId :: Column f AuthorId
101 , projectName :: Column f Text
102 , projectName :: Column f Text
102− }
103+ }
103 deriving stock (Generic)
104 deriving stock (Generic)
104− deriving anyclass (Rel8able
105+ deriving anyclass (Rel8able)
105
106
106To show query results in this documentation, we'll also need ``Show`` instances:
107To show query results in this documentation, we'll also need ``Show`` instances:
107Unfortunately these definitions look a bit scary, but they are essentially just
108Unfortunately these definitions look a bit scary, but they are essentially just
108``deriving (Show)``::
109``deriving (Show)``::
109
110
110− deriving stock instance f ~ Identity => Show (Author f)
111+ deriving stock instance f ~ Result => Show (Author f)
111− deriving stock instance f ~ Identity => Show (Project f)
112+ deriving stock instance f ~ Result => Show (Project f)
112
113
113These data types describe the structural mapping of the tables, but we also
114These data types describe the structural mapping of the tables, but we also
114need to specify a ``TableSchema`` for each table. A ``TableSchema`` contains
115need to specify a ``TableSchema`` for each table. A ``TableSchema`` contains
@@ -125,9 +126,9 @@ associated with the ``Author`` type::
125
126
126 authorSchema :: TableSchema (Author Name)
127 authorSchema :: TableSchema (Author Name)
127 authorSchema = TableSchema
128 authorSchema = TableSchema
128− { tableName = "author"
129+ { name = "author"
129− , tableSchema = Nothing
130+ , schema = Nothing
130− , tableColumns = Author
131+ , columns = Author
131 { authorId = "author_id"
132 { authorId = "author_id"
132 , authorName = "name"
133 , authorName = "name"
133 , authorUrl = "url"
134 , authorUrl = "url"
@@ -138,14 +139,27 @@ And likewise for ``project`` and ``Project``::
138
139
139 projectSchema :: TableSchema (Project Name)
140 projectSchema :: TableSchema (Project Name)
140 projectSchema = TableSchema
141 projectSchema = TableSchema
141− { tableName = "project"
142+ { name = "project"
142− , tableSchema = Nothing
143+ , schema = Nothing
143− , tableColumns = Project
144+ , columns = Project
144 { projectAuthorId = "author_id"
145 { projectAuthorId = "author_id"
145 , projectName = "name"
146 , projectName = "name"
146 }
147 }
147 }
148 }
148
149
150+There is also some generics machinery available if you want to grab the field
151+information from your ``Rel8able`` type::
152+
153+ projectSchema :: TableSchema (Project Name)
154+ projectSchema = TableSchema
155+ { name = "project"
156+ , schema = Nothing
157+ , columns = namesFromLabels @(Project Name)
158+ }
159+
160+This will create a ``TableSchema`` for ``Project`` where every column name
161+corresponds exactly to the name of the field. If you need more flexibility, you
162+can use ``namesFromLabelsWith``, which takes a transformation function.
149
163
150.. note::
164.. note::
151
165
@@ -169,7 +183,7 @@ database heavy applications.
169
183
170In Rel8, ``SELECT`` statements are built using the ``Query`` monad. You can
184In Rel8, ``SELECT`` statements are built using the ``Query`` monad. You can
171think of this monad like the ordinary ``[]`` (List) monad - but this isn't
185think of this monad like the ordinary ``[]`` (List) monad - but this isn't
172−required knowledge.
186+required knowledge.
173
187
174To start, we'll look at one of the simplest queries possible - a basic ``SELECT
188To start, we'll look at one of the simplest queries possible - a basic ``SELECT
175* FROM`` statement. To select all rows from a table, we use ``each``, and
189* FROM`` statement. To select all rows from a table, we use ``each``, and
@@ -190,25 +204,28 @@ Recall we defined ``projectAuthorId`` as ``Column f AuthorId``. Now we have
190We'll see more about ``Expr`` soon, but you can think of ``Expr a`` as "SQL
204We'll see more about ``Expr`` soon, but you can think of ``Expr a`` as "SQL
191expressions of type ``a``\".
205expressions of type ``a``\".
192
206
193−To execute this ``Query``, we pass it to ``select``::
207+To execute this ``Query``, we pass it to ``select``. This function takes both a
208+database connection (which can be obtained using hasql's ``acquire`` function),
209+and the ``Query`` to run::
194
210
211+ >>> Right conn <- acquire "user=postgres"
195− >>> :t select c (each projectSchema)
212+ >>> :t select conn (each projectSchema)
196− select c (each projectSchema) :: MonadIO m => m [Project Identity]
213+ select conn (each projectSchema) :: MonadIO m => m [Project Result]
197
214
198−When we ``select`` things containing ``Expr``s, Rel8 builds a new response
215+When we ``select`` things containing ``Expr``\s, Rel8 builds a new response
199−table with the ``Identity`` interpretation. This means you'll get back plain
216+table with the ``Result`` interpretation. This means you'll get back plain
200Haskell values. Studying ``projectAuthorId`` again, we have::
217Haskell values. Studying ``projectAuthorId`` again, we have::
201
218
202− >>> let aProjectIdentity = undefined :: Project Identity
219+ >>> let aProjectResult = undefined :: Project Result
203− >>> :t projectAuthorId aProjectIdentity
220+ >>> :t projectAuthorId aProjectResult
204− projectAuthorId aProjectIdentity :: AuthorId
221+ projectAuthorId aProjectResult :: AuthorId
205
222
206−Here ``Column Identity AuthorId`` reduces to just ``AuthorId``, with no
223+Here ``Column Result AuthorId`` reduces to just ``AuthorId``, with no
207wrappping type at all.
224wrappping type at all.
208
225
209Putting this all together, we can run our first query::
226Putting this all together, we can run our first query::
210
227
211− >>> select c (each projectSchema) >>= mapM_ print
228+ >>> select conn (each projectSchema) >>= mapM_ print
212 Project {projectAuthorId = 1, projectName = "rel8"}
229 Project {projectAuthorId = 1, projectName = "rel8"}
213 Project {projectAuthorId = 2, projectName = "aeson"}
230 Project {projectAuthorId = 2, projectName = "aeson"}
214 Project {projectAuthorId = 2, projectName = "text"}
231 Project {projectAuthorId = 2, projectName = "text"}
@@ -218,7 +235,7 @@ sometimes we're only interested in a subset of the columns of a table. To
218restrict the returned columns, we can specify a projection by using ``Query``\s
235restrict the returned columns, we can specify a projection by using ``Query``\s
219``Functor`` instance::
236``Functor`` instance::
220
237
221− >>> select c $ projectName <$> each projectSchema
238+ >>> select conn $ projectName <$> each projectSchema
222 ["rel8","aeson","text"]
239 ["rel8","aeson","text"]
223
240
224Joins
241Joins
@@ -234,7 +251,7 @@ We can do this by simply calling ``each`` twice, and then returning a tuple of
234their results::
251their results::
235
252
236 >>> :{
253 >>> :{
237− mapM_ print =<< select c do
254+ mapM_ print =<< select conn do
238 author <- each authorSchema
255 author <- each authorSchema
239 project <- each projectSchema
256 project <- each projectSchema
240 return (projectName project, authorName author)
257 return (projectName project, authorName author)
@@ -253,7 +270,7 @@ This isn't quite right, though, as we have ended up pairing up the wrong
253projects and authors. To fix this, we can use ``where_`` to restrict the
270projects and authors. To fix this, we can use ``where_`` to restrict the
254returned rows. We could write::
271returned rows. We could write::
255
272
256− select c $ do
273+ select conn $ do
257 author <- each authorSchema
274 author <- each authorSchema
258 project <- each projectSchema
275 project <- each projectSchema
259 where_ $ projectAuthorId project ==. authorId author
276 where_ $ projectAuthorId project ==. authorId author
@@ -270,7 +287,7 @@ for the particular joins in your database. In our case, this would be::
270Our final query is then::
287Our final query is then::
271
288
272 >>> :{
289 >>> :{
273− mapM_ print =<< select c do
290+ mapM_ print =<< select conn do
274 author <- each authorSchema
291 author <- each authorSchema
275 project <- projectsForAuthor author
292 project <- projectsForAuthor author
276 return (projectName project, authorName author)
293 return (projectName project, authorName author)
@@ -289,7 +306,7 @@ transformer to allow for the possibility of the join to fail.
289In our test database, we can see that there's another author who we haven't
306In our test database, we can see that there's another author who we haven't
290seen yet::
307seen yet::
291
308
292− >>> select c $ authorName <$> each authorSchema
309+ >>> select conn $ authorName <$> each authorSchema
293 ["Ollie","Bryan O'Sullivan","Emily Pillmore"]
310 ["Ollie","Bryan O'Sullivan","Emily Pillmore"]
294
311
295Emily wasn't returned in our earlier query because - in our database - she
312Emily wasn't returned in our earlier query because - in our database - she
@@ -297,7 +314,7 @@ doesn't have any registered projects. We can account for this partiality in our
297original query by wrapping the ``projectsForAuthor`` call with ``optional``::
314original query by wrapping the ``projectsForAuthor`` call with ``optional``::
298
315
299 >>> :{
316 >>> :{
300− mapM_ print =<< select c do
317+ mapM_ print =<< select conn do
301 author <- each authorSchema
318 author <- each authorSchema
302 mproject <- optional $ projectsForAuthor author
319 mproject <- optional $ projectsForAuthor author
303 return (authorName author, projectName <$> mproject)
320 return (authorName author, projectName <$> mproject)
@@ -342,9 +359,9 @@ focus on the /type/ of that query::
342 return (author, project)
359 return (author, project)
343 where
360 where
344
361
345− >>> :t select c authorsAndProjects
362+ >>> :t select conn authorsAndProjects
346− select c authorsAndProjects
363+ select conn authorsAndProjects
347− :: MonadIO m => m [(Author Identity, Project Identity)]
364+ :: MonadIO m => m [(Author Result, Project Result)]
348
365
349
366
350Our query gives us a single list of pairs of authors and projects. However,
367Our query gives us a single list of pairs of authors and projects. However,
@@ -352,7 +369,7 @@ with our domain knowledge of the schema, this isn't a great type - what we'd
352rather have is a list of pairs of authors and /lists/ of projects. That is,
369rather have is a list of pairs of authors and /lists/ of projects. That is,
353what we'd like is::
370what we'd like is::
354
371
355− [(Author Identity, [Project Identity])]
372+ [(Author Result, [Project Result])]
356
373
357This would be a much better type! Rel8 can produce a query with this type by
374This would be a much better type! Rel8 can produce a query with this type by
358simply wrapping the call to ``projectsForAuthor`` with either ``some`` or
375simply wrapping the call to ``projectsForAuthor`` with either ``some`` or
@@ -360,7 +377,7 @@ simply wrapping the call to ``projectsForAuthor`` with either ``some`` or
360author to have no projects::
377author to have no projects::
361
378
362 >>> :{
379 >>> :{
363− mapM_ print =<< select c do
380+ mapM_ print =<< select conn do
364 author <- each authorSchema
381 author <- each authorSchema
365 projectNames <- many $ projectName <$> projectsForAuthor author
382 projectNames <- many $ projectName <$> projectsForAuthor author
366 return (authorName author, projectNames)
383 return (authorName author, projectNames)
nix/sources.json+9−9
@@ -5,10 +5,10 @@
5 "homepage": "https://input-output-hk.github.io/haskell.nix",
5 "homepage": "https://input-output-hk.github.io/haskell.nix",
6 "owner": "input-output-hk",
6 "owner": "input-output-hk",
7 "repo": "haskell.nix",
7 "repo": "haskell.nix",
8− "rev": "5b5a18e442df6e27ad8549d69b8868b62adb08c3",
8+ "rev": "0837156c56cb5350dd9bd84eb424187e00aa1e8a",
9− "sha256": "055mk7kmjppng66ppnb8kr96v4wwc8pcxfsls5gl77129hsz9aph",
9+ "sha256": "1djmv5a0vfj78csw2cad6nicrs8iqrp928b9b3v4h7lwwhhzliwl",
10 "type": "tarball",
10 "type": "tarball",
11− "url": "https://github.com/input-output-hk/haskell.nix/archive/5b5a18e442df6e27ad8549d69b8868b62adb08c3.tar.gz",
11+ "url": "https://github.com/input-output-hk/haskell.nix/archive/0837156c56cb5350dd9bd84eb424187e00aa1e8a.tar.gz",
12 "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
12 "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
13 },
13 },
14 "niv": {
14 "niv": {
@@ -17,10 +17,10 @@
17 "homepage": "https://github.com/nmattia/niv",
17 "homepage": "https://github.com/nmattia/niv",
18 "owner": "nmattia",
18 "owner": "nmattia",
19 "repo": "niv",
19 "repo": "niv",
20− "rev": "af958e8057f345ee1aca714c1247ef3ba1c15f5e",
20+ "rev": "acdb1726783637852c01e0ad639ac9cbec28d8c8",
21− "sha256": "1qjavxabbrsh73yck5dcq8jggvh3r2jkbr6b5nlz5d9yrqm9255n",
21+ "sha256": "1wszl8q70z6wfgkh2dvgmhhry6qp9nar421qq2ifd17hq2jj9ck3",
22 "type": "tarball",
22 "type": "tarball",
23− "url": "https://github.com/nmattia/niv/archive/af958e8057f345ee1aca714c1247ef3ba1c15f5e.tar.gz",
23+ "url": "https://github.com/nmattia/niv/archive/acdb1726783637852c01e0ad639ac9cbec28d8c8.tar.gz",
24 "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
24 "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
25 },
25 },
26 "nixpkgs": {
26 "nixpkgs": {
@@ -29,10 +29,10 @@
29 "homepage": null,
29 "homepage": null,
30 "owner": "nixos",
30 "owner": "nixos",
31 "repo": "nixpkgs",
31 "repo": "nixpkgs",
32− "rev": "a6847cb5460b47241eb35d1a6588652411642066",
32+ "rev": "1c1f5649bb9c1b0d98637c8c365228f57126f361",
33− "sha256": "0wb5hwgffr4in66qng22sfvbascwnq078q81ziwwayvmnkn73rrm",
33+ "sha256": "0f2nvdijyxfgl5kwyb4465pppd5vkhqxddx6v40k2s0z9jfhj0xl",
34 "type": "tarball",
34 "type": "tarball",
35− "url": "https://github.com/nixos/nixpkgs/archive/a6847cb5460b47241eb35d1a6588652411642066.tar.gz",
35+ "url": "https://github.com/nixos/nixpkgs/archive/1c1f5649bb9c1b0d98637c8c365228f57126f361.tar.gz",
36 "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
36 "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
37 }
37 }
38}
38}
nix/sources.nix+66−20
@@ -6,25 +6,53 @@ let
6 # The fetchers. fetch_<type> fetches specs of type <type>.
6 # The fetchers. fetch_<type> fetches specs of type <type>.
7 #
7 #
8
8
9− fetch_file = pkgs: spec:
9+ fetch_file = pkgs: name: spec:
10+ let
11+ name' = sanitizeName name + "-src";
12+ in
10− if spec.builtin or true then
13+ if spec.builtin or true then
11− builtins_fetchurl { inherit (spec) url sha256; }
14+ builtins_fetchurl { inherit (spec) url sha256; name = name'; }
12− else
15+ else
13− pkgs.fetchurl { inherit (spec) url sha256; };
16+ pkgs.fetchurl { inherit (spec) url sha256; name = name'; };
14
17
15 fetch_tarball = pkgs: name: spec:
18 fetch_tarball = pkgs: name: spec:
16 let
19 let
17− ok = str: ! builtins.isNull (builtins.match "[a-zA-Z0-9+-._?=]" str);
20+ name' = sanitizeName name + "-src";
18− # sanitize the name, though nix will still fail if name starts with period
19− name' = stringAsChars (x: if ! ok x then "-" else x) "${name}-src";
20 in
21 in
21 if spec.builtin or true then
22 if spec.builtin or true then
22 builtins_fetchTarball { name = name'; inherit (spec) url sha256; }
23 builtins_fetchTarball { name = name'; inherit (spec) url sha256; }
23 else
24 else
24 pkgs.fetchzip { name = name'; inherit (spec) url sha256; };
25 pkgs.fetchzip { name = name'; inherit (spec) url sha256; };
25
26
26− fetch_git = spec:
27+ fetch_git = name: spec:
28+ let
29+ ref =
30+ if spec ? ref then spec.ref else
31+ if spec ? branch then "refs/heads/${spec.branch}" else
32+ if spec ? tag then "refs/tags/${spec.tag}" else
33+ abort "In git source '${name}': Please specify `ref`, `tag` or `branch`!";
34+ submodules = if spec ? submodules then spec.submodules else false;
35+ submoduleArg =
36+ let
37+ nixSupportsSubmodules = builtins.compareVersions builtins.nixVersion "2.4" >= 0;
38+ emptyArgWithWarning =
39+ if submodules == true
40+ then
41+ builtins.trace
42+ (
43+ "The niv input \"${name}\" uses submodules "
44+ + "but your nix's (${builtins.nixVersion}) builtins.fetchGit "
45+ + "does not support them"
46+ )
47+ {}
48+ else {};
49+ in
50+ if nixSupportsSubmodules
51+ then { inherit submodules; }
52+ else emptyArgWithWarning;
53+ in
54+ builtins.fetchGit
27− builtins.fetchGit { url = spec.repo; inherit (spec) rev ref; };
55+ ({ url = spec.repo; inherit (spec) rev; inherit ref; } // submoduleArg);
28
56
29 fetch_local = spec: spec.path;
57 fetch_local = spec: spec.path;
30
58
@@ -40,11 +68,21 @@ let
40 # Various helpers
68 # Various helpers
41 #
69 #
42
70
71+ # https://github.com/NixOS/nixpkgs/pull/83241/files#diff-c6f540a4f3bfa4b0e8b6bafd4cd54e8bR695
72+ sanitizeName = name:
73+ (
74+ concatMapStrings (s: if builtins.isList s then "-" else s)
75+ (
76+ builtins.split "[^[:alnum:]+._?=-]+"
77+ ((x: builtins.elemAt (builtins.match "\\.*(.*)" x) 0) name)
78+ )
79+ );
80+
43 # The set of packages used when specs are fetched using non-builtins.
81 # The set of packages used when specs are fetched using non-builtins.
44− mkPkgs = sources:
82+ mkPkgs = sources: system:
45 let
83 let
46 sourcesNixpkgs =
84 sourcesNixpkgs =
47− import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) {};
85+ import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) { inherit system; };
48 hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath;
86 hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath;
49 hasThisAsNixpkgsPath = <nixpkgs> == ./.;
87 hasThisAsNixpkgsPath = <nixpkgs> == ./.;
50 in
88 in
@@ -64,9 +102,9 @@ let
64
102
65 if ! builtins.hasAttr "type" spec then
103 if ! builtins.hasAttr "type" spec then
66 abort "ERROR: niv spec ${name} does not have a 'type' attribute"
104 abort "ERROR: niv spec ${name} does not have a 'type' attribute"
67− else if spec.type == "file" then fetch_file pkgs spec
105+ else if spec.type == "file" then fetch_file pkgs name spec
68 else if spec.type == "tarball" then fetch_tarball pkgs name spec
106 else if spec.type == "tarball" then fetch_tarball pkgs name spec
69− else if spec.type == "git" then fetch_git spec
107+ else if spec.type == "git" then fetch_git name spec
70 else if spec.type == "local" then fetch_local spec
108 else if spec.type == "local" then fetch_local spec
71 else if spec.type == "builtin-tarball" then fetch_builtin-tarball name
109 else if spec.type == "builtin-tarball" then fetch_builtin-tarball name
72 else if spec.type == "builtin-url" then fetch_builtin-url name
110 else if spec.type == "builtin-url" then fetch_builtin-url name
@@ -80,7 +118,10 @@ let
80 saneName = stringAsChars (c: if isNull (builtins.match "[a-zA-Z0-9]" c) then "_" else c) name;
118 saneName = stringAsChars (c: if isNull (builtins.match "[a-zA-Z0-9]" c) then "_" else c) name;
81 ersatz = builtins.getEnv "NIV_OVERRIDE_${saneName}";
119 ersatz = builtins.getEnv "NIV_OVERRIDE_${saneName}";
82 in
120 in
83− if ersatz == "" then drv else ersatz;
121+ if ersatz == "" then drv else
122+ # this turns the string into an actual Nix path (for both absolute and
123+ # relative paths)
124+ if builtins.substring 0 1 ersatz == "/" then /. + ersatz else /. + builtins.getEnv "PWD" + "/${ersatz}";
84
125
85 # Ports of functions for older nix versions
126 # Ports of functions for older nix versions
86
127
@@ -98,25 +139,29 @@ let
98
139
99 # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L269
140 # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L269
100 stringAsChars = f: s: concatStrings (map f (stringToCharacters s));
141 stringAsChars = f: s: concatStrings (map f (stringToCharacters s));
142+ concatMapStrings = f: list: concatStrings (map f list);
101 concatStrings = builtins.concatStringsSep "";
143 concatStrings = builtins.concatStringsSep "";
102
144
145+ # https://github.com/NixOS/nixpkgs/blob/8a9f58a375c401b96da862d969f66429def1d118/lib/attrsets.nix#L331
146+ optionalAttrs = cond: as: if cond then as else {};
147+
103 # fetchTarball version that is compatible between all the versions of Nix
148 # fetchTarball version that is compatible between all the versions of Nix
104− builtins_fetchTarball = { url, name, sha256 }@attrs:
149+ builtins_fetchTarball = { url, name ? null, sha256 }@attrs:
105 let
150 let
106 inherit (builtins) lessThan nixVersion fetchTarball;
151 inherit (builtins) lessThan nixVersion fetchTarball;
107 in
152 in
108 if lessThan nixVersion "1.12" then
153 if lessThan nixVersion "1.12" then
109− fetchTarball { inherit name url; }
154+ fetchTarball ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
110 else
155 else
111 fetchTarball attrs;
156 fetchTarball attrs;
112
157
113 # fetchurl version that is compatible between all the versions of Nix
158 # fetchurl version that is compatible between all the versions of Nix
114− builtins_fetchurl = { url, sha256 }@attrs:
159+ builtins_fetchurl = { url, name ? null, sha256 }@attrs:
115 let
160 let
116 inherit (builtins) lessThan nixVersion fetchurl;
161 inherit (builtins) lessThan nixVersion fetchurl;
117 in
162 in
118 if lessThan nixVersion "1.12" then
163 if lessThan nixVersion "1.12" then
119− fetchurl { inherit url; }
164+ fetchurl ({ inherit url; } // (optionalAttrs (!isNull name) { inherit name; }))
120 else
165 else
121 fetchurl attrs;
166 fetchurl attrs;
122
167
@@ -135,7 +180,8 @@ let
135 mkConfig =
180 mkConfig =
136 { sourcesFile ? if builtins.pathExists ./sources.json then ./sources.json else null
181 { sourcesFile ? if builtins.pathExists ./sources.json then ./sources.json else null
137 , sources ? if isNull sourcesFile then {} else builtins.fromJSON (builtins.readFile sourcesFile)
182 , sources ? if isNull sourcesFile then {} else builtins.fromJSON (builtins.readFile sourcesFile)
183+ , system ? builtins.currentSystem
138− , pkgs ? mkPkgs sources
184+ , pkgs ? mkPkgs sources system
139 }: rec {
185 }: rec {
140 # The sources, i.e. the attribute set of spec name to spec
186 # The sources, i.e. the attribute set of spec name to spec
141 inherit sources;
187 inherit sources;
rel8.cabal+68−32
@@ -1,25 +1,36 @@
1cabal-version: 2.0
1cabal-version: 2.0
2name: rel8
2name: rel8
3−version: 0.1.0.0
3+version: 1.4.0.0
4synopsis: Hey! Hey! Can u rel8?
4synopsis: Hey! Hey! Can u rel8?
5license: BSD3
5license: BSD3
6license-file: LICENSE
6license-file: LICENSE
7author: Oliver Charles
7author: Oliver Charles
8maintainer: ollie@ocharles.org.uk
8maintainer: ollie@ocharles.org.uk
9+homepage: https://github.com/circuithub/rel8
10+bug-reports: https://github.com/circuithub/rel8/issues
9build-type: Simple
11build-type: Simple
12+extra-doc-files:
13+ README.md
14+ Changelog.md
15+
16+source-repository head
17+ type: git
18+ location: https://github.com/circuithub/rel8
10
19
11library
20library
12 build-depends:
21 build-depends:
13 aeson
22 aeson
14− , base ^>= 4.14 || ^>=4.15
23+ , base ^>= 4.14 || ^>=4.15 || ^>=4.16
24+ , bifunctors
15 , bytestring
25 , bytestring
16 , case-insensitive
26 , case-insensitive
17− , casing
27+ , comonad
18 , contravariant
28 , contravariant
19− , hasql ^>= 1.4.5.1
29+ , hasql ^>= 1.4.5.1 || ^>= 1.5.0.0 || ^>= 1.6.0.0
20− , higgledy
21− , opaleye ^>= 0.7.1.0
30+ , opaleye ^>= 0.9.6.1
31+ , pretty
22 , profunctors
32 , profunctors
33+ , product-profunctors
23 , scientific
34 , scientific
24 , semialign
35 , semialign
25 , semigroupoids
36 , semigroupoids
@@ -30,10 +41,12 @@ library
30 default-language:
41 default-language:
31 Haskell2010
42 Haskell2010
32 ghc-options:
43 ghc-options:
44+ -Werror=missing-methods -Werror=incomplete-patterns -Werror=missing-fields
33 -Weverything -Wno-unsafe -Wno-safe -Wno-missing-safe-haskell-mode
45 -Weverything -Wno-unsafe -Wno-safe -Wno-missing-safe-haskell-mode
34 -Wno-missing-import-lists -Wno-prepositive-qualified-module
46 -Wno-missing-import-lists -Wno-prepositive-qualified-module
35 -Wno-monomorphism-restriction
47 -Wno-monomorphism-restriction
36− -Wno-missing-local-signatures
48+ -Wno-missing-local-signatures
49+ -Wno-missing-kind-signatures
37 hs-source-dirs:
50 hs-source-dirs:
38 src
51 src
39 exposed-modules:
52 exposed-modules:
@@ -43,33 +56,48 @@ library
43 Rel8.Expr.Time
56 Rel8.Expr.Time
44 Rel8.Tabulate
57 Rel8.Tabulate
45
58
46− -- deprecated
47− Rel8.Aggregate.Legacy
48−
49 other-modules:
59 other-modules:
50 Rel8.Aggregate
60 Rel8.Aggregate
51
61
62+ Rel8.Column
63+ Rel8.Column.ADT
64+ Rel8.Column.Either
65+ Rel8.Column.Lift
66+ Rel8.Column.List
67+ Rel8.Column.Maybe
68+ Rel8.Column.NonEmpty
69+ Rel8.Column.Null
70+ Rel8.Column.These
71+
52 Rel8.Expr
72 Rel8.Expr
53 Rel8.Expr.Aggregate
73 Rel8.Expr.Aggregate
54 Rel8.Expr.Array
74 Rel8.Expr.Array
55 Rel8.Expr.Bool
75 Rel8.Expr.Bool
76+ Rel8.Expr.Default
56 Rel8.Expr.Eq
77 Rel8.Expr.Eq
57 Rel8.Expr.Function
78 Rel8.Expr.Function
58 Rel8.Expr.Null
79 Rel8.Expr.Null
59 Rel8.Expr.Opaleye
80 Rel8.Expr.Opaleye
60 Rel8.Expr.Ord
81 Rel8.Expr.Ord
61 Rel8.Expr.Order
82 Rel8.Expr.Order
83+ Rel8.Expr.Sequence
62 Rel8.Expr.Serialize
84 Rel8.Expr.Serialize
85+ Rel8.Expr.Window
63
86
64 Rel8.FCF
87 Rel8.FCF
65
88
89+ Rel8.Kind.Algebra
66 Rel8.Kind.Context
90 Rel8.Kind.Context
67− Rel8.Kind.Labels
68− Rel8.Kind.Necessity
69
91
92+ Rel8.Generic.Construction
93+ Rel8.Generic.Construction.ADT
94+ Rel8.Generic.Construction.Record
70 Rel8.Generic.Map
95 Rel8.Generic.Map
71 Rel8.Generic.Record
96 Rel8.Generic.Record
97+ Rel8.Generic.Rel8able
72 Rel8.Generic.Table
98 Rel8.Generic.Table
99+ Rel8.Generic.Table.ADT
100+ Rel8.Generic.Table.Record
73
101
74 Rel8.Order
102 Rel8.Order
75
103
@@ -78,28 +106,26 @@ library
78 Rel8.Query.Distinct
106 Rel8.Query.Distinct
79 Rel8.Query.Each
107 Rel8.Query.Each
80 Rel8.Query.Either
108 Rel8.Query.Either
109+ Rel8.Query.Evaluate
81 Rel8.Query.Exists
110 Rel8.Query.Exists
82 Rel8.Query.Filter
111 Rel8.Query.Filter
112+ Rel8.Query.Indexed
83 Rel8.Query.Limit
113 Rel8.Query.Limit
84 Rel8.Query.List
114 Rel8.Query.List
85 Rel8.Query.Maybe
115 Rel8.Query.Maybe
86 Rel8.Query.Null
116 Rel8.Query.Null
87 Rel8.Query.Opaleye
117 Rel8.Query.Opaleye
88 Rel8.Query.Order
118 Rel8.Query.Order
119+ Rel8.Query.Rebind
89 Rel8.Query.Set
120 Rel8.Query.Set
90 Rel8.Query.SQL
121 Rel8.Query.SQL
91 Rel8.Query.These
122 Rel8.Query.These
92 Rel8.Query.Values
123 Rel8.Query.Values
124+ Rel8.Query.Window
93
125
94− Rel8.Schema.Column
95− Rel8.Schema.Context
96− Rel8.Schema.Context.Label
97 Rel8.Schema.Context.Nullify
126 Rel8.Schema.Context.Nullify
98 Rel8.Schema.Dict
127 Rel8.Schema.Dict
99 Rel8.Schema.Field
128 Rel8.Schema.Field
100− Rel8.Schema.Generic
101− Rel8.Schema.Generic.Test
102− Rel8.Schema.HKD
103 Rel8.Schema.HTable
129 Rel8.Schema.HTable
104 Rel8.Schema.HTable.Either
130 Rel8.Schema.HTable.Either
105 Rel8.Schema.HTable.Identity
131 Rel8.Schema.HTable.Identity
@@ -111,51 +137,54 @@ library
111 Rel8.Schema.HTable.Nullify
137 Rel8.Schema.HTable.Nullify
112 Rel8.Schema.HTable.Product
138 Rel8.Schema.HTable.Product
113 Rel8.Schema.HTable.These
139 Rel8.Schema.HTable.These
114− Rel8.Schema.HTable.Type
115 Rel8.Schema.HTable.Vectorize
140 Rel8.Schema.HTable.Vectorize
116− Rel8.Schema.Insert
117 Rel8.Schema.Kind
141 Rel8.Schema.Kind
118 Rel8.Schema.Name
142 Rel8.Schema.Name
119 Rel8.Schema.Null
143 Rel8.Schema.Null
120− Rel8.Schema.Reify
121 Rel8.Schema.Result
144 Rel8.Schema.Result
122 Rel8.Schema.Spec
145 Rel8.Schema.Spec
123− Rel8.Schema.Spec.ConstrainDBType
124− Rel8.Schema.Spec.ConstrainType
125− Rel8.Schema.Structure
126 Rel8.Schema.Table
146 Rel8.Schema.Table
127
147
128 Rel8.Statement.Delete
148 Rel8.Statement.Delete
129 Rel8.Statement.Insert
149 Rel8.Statement.Insert
150+ Rel8.Statement.OnConflict
130 Rel8.Statement.Returning
151 Rel8.Statement.Returning
131 Rel8.Statement.Select
152 Rel8.Statement.Select
153+ Rel8.Statement.Set
154+ Rel8.Statement.SQL
132 Rel8.Statement.Update
155 Rel8.Statement.Update
156+ Rel8.Statement.Using
133 Rel8.Statement.View
157 Rel8.Statement.View
158+ Rel8.Statement.Where
134
159
135 Rel8.Table
160 Rel8.Table
161+ Rel8.Table.ADT
136 Rel8.Table.Aggregate
162 Rel8.Table.Aggregate
137 Rel8.Table.Alternative
163 Rel8.Table.Alternative
138 Rel8.Table.Bool
164 Rel8.Table.Bool
165+ Rel8.Table.Cols
139 Rel8.Table.Either
166 Rel8.Table.Either
140 Rel8.Table.Eq
167 Rel8.Table.Eq
141− Rel8.Table.Insert
168+ Rel8.Table.HKD
142 Rel8.Table.List
169 Rel8.Table.List
143 Rel8.Table.Maybe
170 Rel8.Table.Maybe
144 Rel8.Table.Name
171 Rel8.Table.Name
145 Rel8.Table.NonEmpty
172 Rel8.Table.NonEmpty
173+ Rel8.Table.Null
174+ Rel8.Table.Nullify
146 Rel8.Table.Opaleye
175 Rel8.Table.Opaleye
147 Rel8.Table.Ord
176 Rel8.Table.Ord
148 Rel8.Table.Order
177 Rel8.Table.Order
149− Rel8.Table.Recontextualize
178+ Rel8.Table.Projection
179+ Rel8.Table.Rel8able
150 Rel8.Table.Serialize
180 Rel8.Table.Serialize
151− Rel8.Table.Tag
152 Rel8.Table.These
181 Rel8.Table.These
182+ Rel8.Table.Transpose
153 Rel8.Table.Undefined
183 Rel8.Table.Undefined
154− Rel8.Table.Unreify
184+ Rel8.Table.Window
155
185
156 Rel8.Type
186 Rel8.Type
157 Rel8.Type.Array
187 Rel8.Type.Array
158− Rel8.Type.Array1D
159 Rel8.Type.Composite
188 Rel8.Type.Composite
160 Rel8.Type.Eq
189 Rel8.Type.Eq
161 Rel8.Type.Enum
190 Rel8.Type.Enum
@@ -171,6 +200,9 @@ library
171 Rel8.Type.Sum
200 Rel8.Type.Sum
172 Rel8.Type.Tag
201 Rel8.Type.Tag
173
202
203+ Rel8.Window
204+
205+
174test-suite tests
206test-suite tests
175 type: exitcode-stdio-1.0
207 type: exitcode-stdio-1.0
176 build-depends:
208 build-depends:
@@ -179,9 +211,9 @@ test-suite tests
179 , case-insensitive
211 , case-insensitive
180 , containers
212 , containers
181 , hasql
213 , hasql
214+ , hasql-transaction
182− , hedgehog ^>=1.0.2
215+ , hedgehog ^>= 1.0 || ^>= 1.1
183− , lifted-base ^>=0.2.3.12
216+ , mmorph
184− , monad-control ^>=1.0.2.3
185 , rel8
217 , rel8
186 , scientific
218 , scientific
187 , tasty
219 , tasty
@@ -189,8 +221,12 @@ test-suite tests
189 , text
221 , text
190 , time
222 , time
191 , tmp-postgres ^>=1.34.1.0
223 , tmp-postgres ^>=1.34.1.0
224+ , transformers
192 , uuid
225 , uuid
193
226
227+ other-modules:
228+ Rel8.Generic.Rel8able.Test
229+
194 main-is: Main.hs
230 main-is: Main.hs
195 hs-source-dirs: tests
231 hs-source-dirs: tests
196 default-language: Haskell2010
232 default-language: Haskell2010
shell.nix+1−1
@@ -1,6 +1,6 @@
1let
1let
2 sources = import ./nix/sources.nix;
2 sources = import ./nix/sources.nix;
3− pkgs = import sources.nixpkgs {};
3+ pkgs = import sources.nixpkgs {overlays = [];};
4 hsPkgs = import ./default.nix;
4 hsPkgs = import ./default.nix;
5in
5in
6 hsPkgs.shellFor {
6 hsPkgs.shellFor {
src/Rel8.hs+371−41
@@ -14,8 +14,8 @@ module Rel8
14 , ReadShow(..)
14 , ReadShow(..)
15
15
16 -- **** Generic
16 -- **** Generic
17− , Composite(..)
17+ , Composite(..), DBComposite(..), compose, decompose
18− , Enum(..)
18+ , Enum(..), DBEnum(..), Enumable
19
19
20 -- *** @TypeInformation@
20 -- *** @TypeInformation@
21 , TypeInformation(..)
21 , TypeInformation(..)
@@ -28,34 +28,42 @@ module Rel8
28 , DBNum
28 , DBNum
29 , DBIntegral
29 , DBIntegral
30 , DBFractional
30 , DBFractional
31+ , DBFloating
31
32
32 -- * Tables and higher-kinded tables
33 -- * Tables and higher-kinded tables
33 , Rel8able, KRel8able
34 , Rel8able, KRel8able
34− , Column, Field, Necessity( Required, Optional )
35+ , Column
35− , Default
36+ , HADT
36 , HEither
37 , HEither
37 , HMaybe
38 , HMaybe
38 , HList
39 , HList
39 , HNonEmpty
40 , HNonEmpty
41+ , HNull
40 , HThese
42 , HThese
41 , Lift
43 , Lift
42
44
43 , Table(..)
45 , Table(..)
46+ , HTable
47+ , Transposes
44 , AltTable((<|>:))
48 , AltTable((<|>:))
49+ , AlternativeTable( emptyTable )
45− , EqTable, (==:), (/=:)
50+ , EqTable(..), (==:), (/=:)
46− , OrdTable, ascTable, descTable
51+ , OrdTable(..), (<:), (<=:), (>:), (>=:), ascTable, descTable, greatest, least
47 , lit
52 , lit
48 , bool
53 , bool
49 , case_
54 , case_
55+ , castTable
50
56
51 -- ** @MaybeTable@
57 -- ** @MaybeTable@
52 , MaybeTable
58 , MaybeTable
53 , maybeTable, ($?), nothingTable, justTable
59 , maybeTable, ($?), nothingTable, justTable
54 , isNothingTable, isJustTable
60 , isNothingTable, isJustTable
61+ , fromMaybeTable
55 , optional
62 , optional
56 , catMaybeTable
63 , catMaybeTable
57− , bindMaybeTable
58 , traverseMaybeTable
64 , traverseMaybeTable
65+ , aggregateMaybeTable
66+ , nameMaybeTable
59
67
60 -- ** @EitherTable@
68 -- ** @EitherTable@
61 , EitherTable
69 , EitherTable
@@ -63,8 +71,9 @@ module Rel8
63 , isLeftTable, isRightTable
71 , isLeftTable, isRightTable
64 , keepLeftTable
72 , keepLeftTable
65 , keepRightTable
73 , keepRightTable
66− , bindEitherTable
67 , bitraverseEitherTable
74 , bitraverseEitherTable
75+ , aggregateEitherTable
76+ , nameEitherTable
68
77
69 -- ** @TheseTable@
78 -- ** @TheseTable@
70 , TheseTable
79 , TheseTable
@@ -72,22 +81,73 @@ module Rel8
72 , isThisTable, isThatTable, isThoseTable
81 , isThisTable, isThatTable, isThoseTable
73 , hasHereTable, hasThereTable
82 , hasHereTable, hasThereTable
74 , justHereTable, justThereTable
83 , justHereTable, justThereTable
84+ , alignMaybeTable
75 , alignBy
85 , alignBy
76 , keepHereTable, loseHereTable
86 , keepHereTable, loseHereTable
77 , keepThereTable, loseThereTable
87 , keepThereTable, loseThereTable
78 , keepThisTable, loseThisTable
88 , keepThisTable, loseThisTable
79 , keepThatTable, loseThatTable
89 , keepThatTable, loseThatTable
80 , keepThoseTable, loseThoseTable
90 , keepThoseTable, loseThoseTable
81− , bindTheseTable
82 , bitraverseTheseTable
91 , bitraverseTheseTable
92+ , aggregateTheseTable
93+ , nameTheseTable
83
94
84 -- ** @ListTable@
95 -- ** @ListTable@
85 , ListTable
96 , ListTable
97+ , listTable, ($*)
98+ , nameListTable
86 , many
99 , many
100+ , manyExpr
101+ , catListTable
102+ , catList
87
103
88 -- ** @NonEmptyTable@
104 -- ** @NonEmptyTable@
89 , NonEmptyTable
105 , NonEmptyTable
106+ , nonEmptyTable, ($+)
107+ , nameNonEmptyTable
90 , some
108 , some
109+ , someExpr
110+ , catNonEmptyTable
111+ , catNonEmpty
112+
113+ -- ** @NullTable@
114+ , NullTable
115+ , nullableTable, nullTable, nullifyTable
116+ , isNullTable, isNonNullTable
117+ , catNullTable
118+ , nameNullTable
119+ , toNullTable, toMaybeTable
120+
121+ -- ** Algebraic data types / sum types
122+ -- $adts
123+
124+ -- *** Naming of ADTs
125+ -- $naming
126+ , NameADT, nameADT
127+ , ADT, ADTable
128+
129+ -- *** Deconstruction of ADTs
130+ -- $deconstruction
131+ , DeconstructADT, deconstructADT
132+
133+ -- *** Construction of ADTs
134+ -- $construction
135+ , BuildADT, buildADT
136+ , ConstructADT, constructADT
137+
138+ -- *** Other ADT operations
139+ , AggregateADT, aggregateADT
140+
141+ -- *** Miscellaneous notes
142+ -- $misc-notes
143+
144+ -- ** @HKD@
145+ , HKD, HKDable
146+ , BuildHKD, buildHKD
147+ , ConstructHKD, constructHKD
148+ , DeconstructHKD, deconstructHKD
149+ , NameHKD, nameHKD
150+ , AggregateHKD, aggregateHKD
91
151
92 -- ** Table schemas
152 -- ** Table schemas
93 , TableSchema(..)
153 , TableSchema(..)
@@ -100,8 +160,12 @@ module Rel8
100 , Sql
160 , Sql
101 , litExpr
161 , litExpr
102 , unsafeCastExpr
162 , unsafeCastExpr
163+ , unsafeLiteral
103
164
104 -- ** @null@
165 -- ** @null@
166+ , NotNull
167+ , Nullable
168+ , Homonullable
105 , null
169 , null
106 , nullify
170 , nullify
107 , nullable
171 , nullable
@@ -120,6 +184,7 @@ module Rel8
120 , (==.), (/=.), (==?), (/=?)
184 , (==.), (/=.), (==?), (/=?)
121 , in_
185 , in_
122 , boolExpr, caseExpr
186 , boolExpr, caseExpr
187+ , like, ilike
123
188
124 -- ** Ordering
189 -- ** Ordering
125 , DBOrd
190 , DBOrd
@@ -137,6 +202,13 @@ module Rel8
137 , Query
202 , Query
138 , showQuery
203 , showQuery
139
204
205+ -- ** Projection
206+ , Projection
207+ , Projectable( project )
208+ , Biprojectable( biproject )
209+ , Projecting
210+ , Field
211+
140 -- ** Selecting rows
212 -- ** Selecting rows
141 , Selects
213 , Selects
142 , each
214 , each
@@ -145,8 +217,8 @@ module Rel8
145 -- ** Filtering
217 -- ** Filtering
146 , filter
218 , filter
147 , where_
219 , where_
148− , whereExists
220+ , present
149− , whereNotExists
221+ , absent
150 , distinct
222 , distinct
151 , distinctOn
223 , distinctOn
152 , distinctOnBy
224 , distinctOnBy
@@ -176,15 +248,16 @@ module Rel8
176
248
177 -- ** Aggregation
249 -- ** Aggregation
178 , Aggregate
250 , Aggregate
251+ , Aggregates
179 , aggregate
252 , aggregate
180 , countRows
253 , countRows
181− , array1DAggExpr
182− , listAgg, listAggWithOrder, listAggExpr
183− , nonEmptyAgg, nonEmptyAggWithOrder, nonEmptyAggExpr
184 , groupBy
254 , groupBy
255+ , listAgg, listAggExpr
256+ , mode
257+ , nonEmptyAgg, nonEmptyAggExpr
185 , DBMax, max
258 , DBMax, max
186 , DBMin, min
259 , DBMin, min
187− , DBSum, sum, sumWhere
260+ , DBSum, sum, sumWhere, avg
188 , DBString, stringAgg
261 , DBString, stringAgg
189 , count
262 , count
190 , countStar
263 , countStar
@@ -201,48 +274,71 @@ module Rel8
201 , nullsFirst
274 , nullsFirst
202 , nullsLast
275 , nullsLast
203
276
277+ -- ** Window functions
278+ , Window
279+ , window
280+ , Partition
281+ , over
282+ , partitionBy
283+ , orderPartitionBy
284+ , cumulative
285+ , cumulative_
286+ , currentRow
287+ , rowNumber
288+ , rank
289+ , denseRank
290+ , percentRank
291+ , cumeDist
292+ , ntile
293+ , lag
294+ , lead
295+ , firstValue
296+ , lastValue
297+ , nthValue
298+ , indexed
299+
300+ -- ** Bindings
301+ , rebind
302+
204 -- * IO
303 -- * IO
205 , Serializable
304 , Serializable
305+ , ToExprs
306+ , Result
206
307
207 -- * Running statements
308 -- * Running statements
309+ -- $running
310+
208 -- ** @SELECT@
311 -- ** @SELECT@
209 , select
312 , select
210
313
211 -- ** @INSERT@
314 -- ** @INSERT@
212 , Insert(..)
315 , Insert(..)
213 , OnConflict(..)
316 , OnConflict(..)
317+ , Upsert(..)
214 , insert
318 , insert
215− , toInsert
319+ , unsafeDefault
216− , toInsertDefaults
320+ , showInsert
217
321
218 -- ** @DELETE@
322 -- ** @DELETE@
219 , Delete(..)
323 , Delete(..)
220 , delete
324 , delete
325+ , showDelete
221
326
222 -- ** @UPDATE@
327 -- ** @UPDATE@
223− , update
224 , Update(..)
328 , Update(..)
329+ , update
330+ , showUpdate
225
331
226 -- ** @.. RETURNING@
332 -- ** @.. RETURNING@
227 , Returning(..)
333 , Returning(..)
228
334
229 -- ** @CREATE VIEW@
335 -- ** @CREATE VIEW@
230 , createView
336 , createView
337+ , createOrReplaceView
231
338
232− -- * TODO
339+ -- ** Sequences
233− -- TODO
340+ , nextval
234− -- These need organizing, but are reachable from Rel8's documentation so we
341+ , evaluate
235− -- do need to export and document them.
236− , Array1D( Array1D )
237− , NotArray
238− , Nullable
239− , NotNull
240− , HTable
241− , Labelable
242− , ToExprs(..)
243− , FromExprs
244− , Result
245− , HKDT(..)
246 ) where
342 ) where
247
343
248-- base
344-- base
@@ -250,67 +346,88 @@ import Prelude ()
250
346
251-- rel8
347-- rel8
252import Rel8.Aggregate
348import Rel8.Aggregate
349+import Rel8.Column
350+import Rel8.Column.ADT
351+import Rel8.Column.Either
352+import Rel8.Column.Lift
353+import Rel8.Column.List
354+import Rel8.Column.Maybe
355+import Rel8.Column.NonEmpty
356+import Rel8.Column.Null
357+import Rel8.Column.These
253import Rel8.Expr
358import Rel8.Expr
254import Rel8.Expr.Aggregate
359import Rel8.Expr.Aggregate
255import Rel8.Expr.Bool
360import Rel8.Expr.Bool
361+import Rel8.Expr.Default
256import Rel8.Expr.Eq
362import Rel8.Expr.Eq
257import Rel8.Expr.Function
363import Rel8.Expr.Function
258import Rel8.Expr.Null
364import Rel8.Expr.Null
259−import Rel8.Expr.Opaleye (unsafeCastExpr)
365+import Rel8.Expr.Opaleye (unsafeCastExpr, unsafeLiteral)
260import Rel8.Expr.Ord
366import Rel8.Expr.Ord
261import Rel8.Expr.Order
367import Rel8.Expr.Order
262import Rel8.Expr.Serialize
368import Rel8.Expr.Serialize
263−import Rel8.Kind.Necessity
369+import Rel8.Expr.Sequence
370+import Rel8.Expr.Text ( like, ilike )
371+import Rel8.Expr.Window hiding ( cumulative )
372+import Rel8.Generic.Rel8able ( KRel8able, Rel8able )
264import Rel8.Order
373import Rel8.Order
265import Rel8.Query
374import Rel8.Query
266import Rel8.Query.Aggregate
375import Rel8.Query.Aggregate
267import Rel8.Query.Distinct
376import Rel8.Query.Distinct
268import Rel8.Query.Each
377import Rel8.Query.Each
269import Rel8.Query.Either
378import Rel8.Query.Either
379+import Rel8.Query.Evaluate
270import Rel8.Query.Exists
380import Rel8.Query.Exists
271import Rel8.Query.Filter
381import Rel8.Query.Filter
382+import Rel8.Query.Indexed
272import Rel8.Query.Limit
383import Rel8.Query.Limit
273import Rel8.Query.List
384import Rel8.Query.List
274import Rel8.Query.Maybe
385import Rel8.Query.Maybe
275import Rel8.Query.Null
386import Rel8.Query.Null
276import Rel8.Query.Order
387import Rel8.Query.Order
388+import Rel8.Query.Rebind
277import Rel8.Query.SQL (showQuery)
389import Rel8.Query.SQL (showQuery)
278import Rel8.Query.Set
390import Rel8.Query.Set
279import Rel8.Query.These
391import Rel8.Query.These
280import Rel8.Query.Values
392import Rel8.Query.Values
281−import Rel8.Schema.Column
393+import Rel8.Query.Window
282−import Rel8.Schema.Context.Label
283import Rel8.Schema.Field
394import Rel8.Schema.Field
284−import Rel8.Schema.Generic
285−import Rel8.Schema.HKD
286import Rel8.Schema.HTable
395import Rel8.Schema.HTable
287import Rel8.Schema.Name
396import Rel8.Schema.Name
288import Rel8.Schema.Null hiding ( nullable )
397import Rel8.Schema.Null hiding ( nullable )
289−import Rel8.Schema.Result
398+import Rel8.Schema.Result ( Result )
290import Rel8.Schema.Table
399import Rel8.Schema.Table
291import Rel8.Statement.Delete
400import Rel8.Statement.Delete
292import Rel8.Statement.Insert
401import Rel8.Statement.Insert
402+import Rel8.Statement.OnConflict
293import Rel8.Statement.Returning
403import Rel8.Statement.Returning
294import Rel8.Statement.Select
404import Rel8.Statement.Select
405+import Rel8.Statement.SQL
295import Rel8.Statement.Update
406import Rel8.Statement.Update
296import Rel8.Statement.View
407import Rel8.Statement.View
297import Rel8.Table
408import Rel8.Table
409+import Rel8.Table.ADT
298import Rel8.Table.Aggregate
410import Rel8.Table.Aggregate
299import Rel8.Table.Alternative
411import Rel8.Table.Alternative
300import Rel8.Table.Bool
412import Rel8.Table.Bool
301import Rel8.Table.Either
413import Rel8.Table.Either
302import Rel8.Table.Eq
414import Rel8.Table.Eq
303−import Rel8.Table.Insert
415+import Rel8.Table.HKD
304import Rel8.Table.List
416import Rel8.Table.List
305import Rel8.Table.Maybe
417import Rel8.Table.Maybe
306import Rel8.Table.Name
418import Rel8.Table.Name
307import Rel8.Table.NonEmpty
419import Rel8.Table.NonEmpty
420+import Rel8.Table.Null
421+import Rel8.Table.Opaleye ( castTable )
308import Rel8.Table.Ord
422import Rel8.Table.Ord
309import Rel8.Table.Order
423import Rel8.Table.Order
424+import Rel8.Table.Projection
425+import Rel8.Table.Rel8able ()
310import Rel8.Table.Serialize
426import Rel8.Table.Serialize
311import Rel8.Table.These
427import Rel8.Table.These
428+import Rel8.Table.Transpose
429+import Rel8.Table.Window
312import Rel8.Type
430import Rel8.Type
313−import Rel8.Type.Array1D
314import Rel8.Type.Composite
431import Rel8.Type.Composite
315import Rel8.Type.Eq
432import Rel8.Type.Eq
316import Rel8.Type.Enum
433import Rel8.Type.Enum
@@ -324,3 +441,216 @@ import Rel8.Type.ReadShow
324import Rel8.Type.Semigroup
441import Rel8.Type.Semigroup
325import Rel8.Type.String
442import Rel8.Type.String
326import Rel8.Type.Sum
443import Rel8.Type.Sum
444+import Rel8.Window
445+
446+
447+-- $running
448+-- To run queries and otherwise interact with a PostgreSQL database, Rel8
449+-- provides 'select', 'insert', 'update' and 'delete' functions. Note that
450+-- 'insert', 'update' and 'delete' will generally need the
451+-- `DuplicateRecordFields` language extension enabled.
452+
453+-- $adts
454+-- Algebraic data types can be modelled between Haskell and SQL.
455+--
456+-- * Your SQL table needs a certain text field that tags which Haskell constructor is in use.
457+-- * You have to use a few combinators to specify the sum type's individual constructors.
458+-- * If you want to do case analysis at the @Expr@ (SQL) level, you can use 'maybe'/'either'-like eliminators.
459+--
460+-- The documentation in this section will assume a set of database types like this:
461+--
462+-- @
463+-- data Thing f = ThingEmployer (Employer f) | ThingPotato (Potato f) | Nullary
464+-- deriving stock Generic
465+--
466+-- data Employer f = Employer { employerId :: f Int32, employerName :: f Text}
467+-- deriving stock Generic
468+-- deriving anyclass Rel8able
469+--
470+-- data Potato f = Potato { size :: f Int32, grower :: f Text }
471+-- deriving stock Generic
472+-- deriving anyclass Rel8able
473+-- @
474+
475+-- $naming
476+--
477+-- First, in your 'TableSchema', name your type like this:
478+--
479+-- @
480+-- thingSchema :: TableSchema (ADT Thing Name)
481+-- thingSchema =
482+-- TableSchema
483+-- { schema = Nothing,
484+-- name = \"thing\",
485+-- columns =
486+-- nameADT @Thing
487+-- \"tag\"
488+-- Employer
489+-- { employerName = \"name\",
490+-- employerId = \"id\"
491+-- }
492+-- Potato {size = \"size\", grower = \"Mary\"}
493+-- }
494+-- @
495+--
496+-- Note that @nameADT \@Thing "tag"@ is variadic: it accepts one
497+-- argument per constructor, except the nullary ones (Nullary) because
498+-- there's nothing to do for them.
499+
500+-- $deconstruction
501+--
502+-- To deconstruct sum types at the SQL level, use 'deconstructADT',
503+-- which is also variadic, and has one argument for each
504+-- constructor. Similar to 'maybe'.
505+--
506+-- @
507+-- query :: Query (ADT Thing Expr)
508+-- query = do
509+-- thingExpr <- each thingSchema
510+-- where_ $
511+-- deconstructADT @Thing
512+-- (\employer -> employerName employer ==. lit \"Mary\")
513+-- (\potato -> grower potato ==. lit \"Mary\")
514+-- (lit False) -- Nullary case
515+-- thingExpr
516+-- pure thingExpr
517+-- @
518+--
519+-- SQL output:
520+--
521+-- @
522+-- SELECT
523+-- CAST("tag0_1" AS text) as "tag",
524+-- CAST("id1_1" AS int4) as "ThingEmployer/_1/employerId",
525+-- CAST("name2_1" AS text) as "ThingEmployer/_1/employerName",
526+-- CAST("size3_1" AS int4) as "ThingPotato/_1/size",
527+-- CAST("Mary4_1" AS text) as "ThingPotato/_1/grower"
528+-- FROM (SELECT
529+-- *
530+-- FROM (SELECT
531+-- "tag" as "tag0_1",
532+-- "id" as "id1_1",
533+-- "name" as "name2_1",
534+-- "size" as "size3_1",
535+-- "Mary" as "Mary4_1"
536+-- FROM "thing" as "T1") as "T1"
537+-- WHERE (CASE WHEN ("tag0_1") = (CAST(E'ThingPotato' AS text)) THEN ("Mary4_1") = (CAST(E'Mary' AS text))
538+-- WHEN ("tag0_1") = (CAST(E'Nullary' AS text)) THEN CAST(FALSE AS bool) ELSE ("name2_1") = (CAST(E'Mary' AS text)) END)) as "T1"
539+-- @
540+
541+-- $construction
542+--
543+-- To construct an ADT, you can use 'buildADT' or 'constructADT'. Consider the following type:
544+--
545+-- @
546+-- data Task f = Pending | Complete (CompletedTask f)
547+-- @
548+--
549+-- 'buildADT' is for constructing values of 'Task' in the 'Expr'
550+-- context. 'buildADT' needs two type-level arguments before its type
551+-- makes any sense. The first argument is the type of the "ADT", which
552+-- in our case is 'Task'. The second is the name of the constructor we
553+-- want to use. So that means we have the following possible
554+-- instantiations of 'buildADT' for 'Task':
555+--
556+-- @
557+-- > :t buildADT @Task @\"Pending\"
558+-- buildADT @Task @\"Pending\" :: ADT Task Expr
559+-- > :t buildADT @Task @\"Complete\"
560+-- buildADT @Task @\"Complete\" :: CompletedTask Expr -> ADT Task Expr
561+-- @
562+--
563+-- Note that as the "Pending" constructor has no fields, @buildADT
564+-- \@Task \@"Pending"@ is equivalent to @lit Pending@. But @buildADT
565+-- \@Task \@"Complete"@ is not the same as @lit . Complete@:
566+--
567+-- @
568+-- > :t lit . Complete
569+-- lit . Complete :: CompletedTask Result -> ADT Task Expr
570+-- @
571+--
572+--
573+-- Note that the former takes a @CompletedTask Expr@ while the latter
574+-- takes a @CompletedTask Result@. The former is more powerful because
575+-- you can construct @Task@s using dynamic values coming a database
576+-- query.
577+--
578+-- To show what this can look like in SQL, consider:
579+--
580+-- @
581+-- > :{
582+-- showQuery $ values
583+-- [ buildADT @Task @\"Pending\"
584+-- , buildADT @Task @\"Complete\" CompletedTask {date = Rel8.Expr.Time.now}
585+-- ]
586+-- :}
587+-- @
588+--
589+-- This produces the following SQL:
590+--
591+-- @
592+-- SELECT
593+-- CAST(\"values0_1\" AS text) as \"tag\",
594+-- CAST(\"values1_1\" AS timestamptz) as \"Complete/_1/date\"
595+-- FROM (SELECT
596+-- *
597+-- FROM (SELECT \"column1\" as \"values0_1\",
598+-- \"column2\" as \"values1_1\"
599+-- FROM
600+-- (VALUES
601+-- (CAST(E'Pending' AS text),CAST(NULL AS timestamptz)),
602+-- (CAST(E'Complete' AS text),CAST(now() AS timestamptz))) as \"V\") as \"T1\") as \"T1\"
603+-- @
604+--
605+-- This is what you get if you run it in @psql@:
606+--
607+--
608+-- @
609+-- tag | Complete/_1/date
610+-- ----------+-------------------------------
611+-- Pending |
612+-- Complete | 2022-05-19 21:28:23.969065+00
613+-- (2 rows)
614+-- @
615+--
616+-- "constructADT" is less convenient but more general alternative to
617+-- "buildADT". It requires only one type-level argument for its type
618+-- to make sense:
619+--
620+-- @
621+-- > :t constructADT @Task
622+-- constructADT @Task
623+-- :: (forall r. r -> (CompletedTask Expr -> r) -> r) -> ADT Task Expr
624+-- @
625+--
626+-- This might still seem a bit opaque, but basically it gives you a
627+-- Church-encoded constructor for arbitrary algebraic data types. You
628+-- might use it as follows:
629+--
630+-- @
631+-- let
632+-- pending :: ADT Task Expr
633+-- pending = constructADT @Task $ \pending _complete -> pending
634+--
635+-- complete :: ADT Task Expr
636+-- complete = constructADT @Task $ \_pending complete -> complete CompletedTask {date = Rel8.Expr.Time.now}
637+-- @
638+--
639+-- These values are otherwise identical to the ones we saw above with
640+-- @buildADT@, it's just a different style of constructing them.
641+--
642+
643+-- $misc-notes
644+--
645+-- 1. Note that the order of the arguments for all of these functions
646+-- is determined by the order of the constructors in the data
647+-- definition. If it were @data Task = Complete (CompletedTask f) |
648+-- Pending@ then the order of all the invocations of @constructADT@
649+-- and @deconstructADT@ would need to change.
650+--
651+-- 2. Maybe this is obvious, but just to spell it out: once you're in
652+-- the @Result@ context, you can of course construct @Task@ values
653+-- normally and use standard Haskell pattern-matching. @constructADT@
654+-- and @deconstructADT@ are specifically only needed in the @Expr@
655+-- context, and they allow you to do the equivalent of pattern
656+-- matching in PostgreSQL.
src/Rel8/Aggregate.hs+42−128
@@ -1,169 +1,83 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2−{-# language DerivingVia #-}
3{-# language FlexibleContexts #-}
2{-# language FlexibleContexts #-}
4{-# language FlexibleInstances #-}
3{-# language FlexibleInstances #-}
5−{-# language GADTs #-}
6{-# language MultiParamTypeClasses #-}
4{-# language MultiParamTypeClasses #-}
7−{-# language NamedFieldPuns #-}
5+{-# language RankNTypes #-}
8−{-# language PolyKinds #-}
9{-# language StandaloneKindSignatures #-}
6{-# language StandaloneKindSignatures #-}
10{-# language TypeFamilies #-}
7{-# language TypeFamilies #-}
11{-# language UndecidableInstances #-}
8{-# language UndecidableInstances #-}
12−{-# language UndecidableSuperClasses #-}
13
9
14module Rel8.Aggregate
10module Rel8.Aggregate
15− ( Aggregate(..), foldInputs, mapInputs
11+ ( Aggregate(..), zipOutputs
16− , Aggregator(..), unsafeMakeAggregate
12+ , unsafeMakeAggregate
17 , Aggregates
13 , Aggregates
18− , Col( Aggregation )
19 )
14 )
20where
15where
21
16
22-- base
17-- base
23−import Data.Functor.Const ( Const( Const ), getConst )
18+import Control.Applicative ( liftA2 )
24−import Data.Functor.Identity ( Identity )
19+import Data.Functor.Identity ( Identity( Identity ) )
25import Data.Kind ( Constraint, Type )
20import Data.Kind ( Constraint, Type )
26import Prelude
21import Prelude
27
22
23+-- profunctors
24+import Data.Profunctor ( dimap )
25+
28-- opaleye
26-- opaleye
29−import qualified Opaleye.Internal.Aggregate as Opaleye
27+import qualified Opaleye.Aggregate as Opaleye
30import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
28import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
31−import qualified Opaleye.Internal.PackMap as Opaleye
29+import qualified Opaleye.Internal.Column as Opaleye
32
30
33-- rel8
31-- rel8
34−import Rel8.Expr ( Expr, Col(..) )
32+import Rel8.Expr ( Expr )
35−import Rel8.Schema.Context ( Interpretation(..) )
36−import Rel8.Schema.Context.Label ( Labelable(..) )
37−import Rel8.Schema.HTable ( hfield, htabulate, htabulateA, hspecs )
33+import Rel8.Schema.HTable.Identity ( HIdentity(..) )
38−import Rel8.Schema.Name ( Name )
34+import qualified Rel8.Schema.Kind as K
39import Rel8.Schema.Null ( Sql )
35import Rel8.Schema.Null ( Sql )
40−import Rel8.Schema.Reify ( notReify )
41−import Rel8.Schema.Result ( Result )
42−import Rel8.Schema.Spec ( Spec( Spec ), SSpec(..) )
43import Rel8.Table
36import Rel8.Table
44 ( Table, Columns, Context, fromColumns, toColumns
37 ( Table, Columns, Context, fromColumns, toColumns
45− , reify, unreify
38+ , FromExprs, fromResult, toResult
39+ , Transpose
46 )
40 )
47−import Rel8.Table.Recontextualize ( Recontextualize )
41+import Rel8.Table.Transpose ( Transposes )
48import Rel8.Type ( DBType )
42import Rel8.Type ( DBType )
49
43
50−-- semigroupoids
51−import Data.Functor.Apply ( Apply, (<.>) )
52−
53−
54−-- | An @Aggregate a@ describes how to aggregate @Table@s of type @a@. You can
55−-- unpack an @Aggregate@ back to @a@ by running it with 'Rel8.aggregate'. As
56−-- @Aggregate@ is almost an 'Applicative' functor - but there is no 'pure'
57−-- operation. This means 'Aggregate' is an instance of 'Apply', and you can
58−-- combine @Aggregate@s using the @<.>@ combinator.
59−type Aggregate :: k -> Type
60−data Aggregate a where
61− Aggregate :: !(Opaleye.Aggregator () a) -> Aggregate a
62−
63−
64−instance Functor Aggregate where
65− fmap f (Aggregate a) = Aggregate (fmap f a)
66−
67−
68−instance Apply Aggregate where
69− Aggregate f <.> Aggregate a = Aggregate (f <*> a)
70−
71
44
72−instance Interpretation Aggregate where
45+-- | 'Aggregate' is a special context used by 'Rel8.aggregate'.
73− data Col Aggregate _spec where
46+type Aggregate :: K.Context
74− Aggregation :: ()
75− => Aggregate (Expr a)
47+newtype Aggregate a = Aggregate (Opaleye.Aggregator () (Expr a))
76− -> Col Aggregate ('Spec labels necessity a)
77
48
78
49
79−instance Table Expr a => Table Aggregate (Aggregate a) where
50+instance Sql DBType a => Table Aggregate (Aggregate a) where
80− type Columns (Aggregate a) = Columns a
51+ type Columns (Aggregate a) = HIdentity a
81 type Context (Aggregate a) = Aggregate
52 type Context (Aggregate a) = Aggregate
53+ type FromExprs (Aggregate a) = a
54+ type Transpose to (Aggregate a) = to a
82
55
83− toColumns a = htabulate $ \field -> case hfield hspecs field of
56+ toColumns = HIdentity
84− SSpec {} -> Aggregation $ unDB . (`hfield` field) . toColumns <$> a
57+ fromColumns (HIdentity a) = a
85− fromColumns as = fmap fromColumns $ htabulateA $ \field ->
58+ toResult = HIdentity . Identity
86− case hfield as field of
59+ fromResult (HIdentity (Identity a)) = a
87− Aggregation a -> DB <$> a
88−
89− reify = notReify
90− unreify = notReify
91−
92−
93−instance Sql DBType a =>
94− Recontextualize Aggregate Aggregate (Aggregate (Expr a)) (Aggregate (Expr a))
95−
96−
97−instance Sql DBType a =>
98− Recontextualize Aggregate Expr (Aggregate (Expr a)) (Expr a)
99−
100−
101−instance Sql DBType a =>
102− Recontextualize Aggregate Result (Aggregate (Expr a)) (Identity a)
103
60
104
61
105−instance Sql DBType a =>
106− Recontextualize Aggregate Name (Aggregate (Expr a)) (Name a)
107−
108−
109−instance Sql DBType a =>
110− Recontextualize Expr Aggregate (Expr a) (Aggregate (Expr a))
111−
112−
113−instance Sql DBType a =>
114− Recontextualize Result Aggregate (Identity a) (Aggregate (Expr a))
115−
116−
117−instance Sql DBType a =>
118− Recontextualize Name Aggregate (Name a) (Aggregate (Expr a))
119−
120−
121−instance Labelable Aggregate where
122− labeler (Aggregation aggregate) = Aggregation aggregate
123− unlabeler (Aggregation aggregate) = Aggregation aggregate
124−
125−
126−-- | @Aggregates a b@ means that the columns in @a@ are all 'Aggregate' 'Expr's
62+-- | @Aggregates a b@ means that the columns in @a@ are all 'Aggregate's
127−-- for the columns in @b@.
63+-- for the 'Expr' columns in @b@.
128type Aggregates :: Type -> Type -> Constraint
64type Aggregates :: Type -> Type -> Constraint
129−class Recontextualize Aggregate Expr aggregates exprs => Aggregates aggregates exprs
65+class Transposes Aggregate Expr aggregates exprs => Aggregates aggregates exprs
130−instance Recontextualize Aggregate Expr aggregates exprs => Aggregates aggregates exprs
66+instance Transposes Aggregate Expr aggregates exprs => Aggregates aggregates exprs
131−
132−
133−foldInputs :: Monoid b
134− => (Maybe Aggregator -> Opaleye.PrimExpr -> b) -> Aggregate a -> b
135−foldInputs f (Aggregate (Opaleye.Aggregator (Opaleye.PackMap agg))) =
136− getConst $ flip agg () $ \(aggregator, a) ->
137− Const $ f (detuplize <$> aggregator) a
138− where
139− detuplize (operation, ordering, distinction) =
140− Aggregator {operation, ordering, distinction}
141−
142−
143−mapInputs :: ()
144− => (Opaleye.PrimExpr -> Opaleye.PrimExpr) -> Aggregate a -> Aggregate a
145−mapInputs transform (Aggregate (Opaleye.Aggregator (Opaleye.PackMap agg))) =
146− Aggregate $ Opaleye.Aggregator $ Opaleye.PackMap $ agg . \f input ->
147− f (fmap transform input)
148
67
149
68
150−type Aggregator :: Type
69+zipOutputs :: ()
151−data Aggregator = Aggregator
70+ => (Expr a -> Expr b -> Expr c) -> Aggregate a -> Aggregate b -> Aggregate c
152− { operation :: Opaleye.AggrOp
71+zipOutputs f (Aggregate a) (Aggregate b) = Aggregate (liftA2 f a b)
153− , ordering :: [Opaleye.OrderExpr]
154− , distinction :: Opaleye.AggrDistinct
155− }
156
72
157
73
158−unsafeMakeAggregate :: ()
74+unsafeMakeAggregate :: forall (input :: Type) (output :: Type) n n' a a'. ()
159− => (input -> Opaleye.PrimExpr)
75+ => (Expr input -> Opaleye.PrimExpr)
160− -> (Opaleye.PrimExpr -> output)
76+ -> (Opaleye.PrimExpr -> Expr output)
161− -> Maybe Aggregator
77+ -> Opaleye.Aggregator (Opaleye.Field_ n a) (Opaleye.Field_ n' a')
162− -> input
78+ -> Expr input
163 -> Aggregate output
79 -> Aggregate output
164unsafeMakeAggregate input output aggregator expr =
80unsafeMakeAggregate input output aggregator expr =
165− Aggregate $ Opaleye.Aggregator $ Opaleye.PackMap $ \f _ ->
81+ Aggregate $ dimap in_ out aggregator
166− output <$> f (tuplize <$> aggregator, input expr)
82+ where out = output . Opaleye.unColumn
167− where
83+ in_ = Opaleye.Column . input . const expr
168− tuplize Aggregator {operation, ordering, distinction} =
169− (operation, ordering, distinction)
src/Rel8/Aggregate/Legacy.hsdeleted−92
@@ -1,92 +0,0 @@
1−{-# language FlexibleContexts #-}
2−{-# language ScopedTypeVariables #-}
3−{-# language TypeApplications #-}
4−{-# language TypeFamilies #-}
5−{-# language ViewPatterns #-}
6−
7−module Rel8.Aggregate.Legacy
8− ( Aggregates
9− , aggregate
10− , aggregateTabulation
11− , groupBy
12− , listAgg
13− , nonEmptyAgg
14− )
15−where
16−
17−-- base
18−import Data.Functor.Identity ( Identity( Identity ) )
19−import Prelude
20−
21−-- opaleye
22−import qualified Opaleye.Aggregate as Opaleye
23−
24−-- rel8
25−import Rel8.Aggregate ( Aggregates, Col(..) )
26−import Rel8.Expr ( Col(..) )
27−import Rel8.Expr.Aggregate ( groupByExpr, listAggExpr, nonEmptyAggExpr )
28−import Rel8.Query ( Query )
29−import Rel8.Query.Opaleye ( mapOpaleye )
30−import Rel8.Schema.Dict ( Dict( Dict ) )
31−import Rel8.Schema.HTable ( htabulate, hfield )
32−import Rel8.Schema.HTable.Vectorize ( hvectorize )
33−import Rel8.Table ( toColumns, fromColumns )
34−import Rel8.Table.Eq ( EqTable, eqTable )
35−import Rel8.Table.List ( ListTable )
36−import Rel8.Table.NonEmpty ( NonEmptyTable )
37−import Rel8.Table.Opaleye ( aggregator )
38−import Rel8.Tabulate ( Tabulation )
39−import qualified Rel8.Tabulate
40−
41−
42−-- | Apply an aggregation to all rows returned by a 'Query'.
43−aggregate :: Aggregates aggregates exprs => Query aggregates -> Query exprs
44−aggregate = mapOpaleye (Opaleye.aggregate aggregator) . fmap (fromColumns . toColumns)
45−
46−
47−aggregateTabulation
48− :: (EqTable k, Aggregates aggregates exprs)
49− => (t -> aggregates) -> Tabulation k t -> Tabulation k exprs
50−aggregateTabulation f =
51− Rel8.Tabulate.aggregateTabulation . fmap (fromColumns . toColumns . f)
52−
53−
54−-- | Group equal tables together. This works by aggregating each column in the
55−-- given table with 'groupByExpr'.
56−groupBy :: forall exprs aggregates. (EqTable exprs, Aggregates aggregates exprs)
57− => exprs -> aggregates
58−groupBy (toColumns -> exprs) = fromColumns $ htabulate $ \field ->
59− case hfield (eqTable @exprs) field of
60− Dict -> case hfield exprs field of
61− DB expr -> Aggregation $ groupByExpr expr
62−
63−
64−-- | Aggregate rows into a single row containing an array of all aggregated
65−-- rows. This can be used to associate multiple rows with a single row, without
66−-- changing the over cardinality of the query. This allows you to essentially
67−-- return a tree-like structure from queries.
68−--
69−-- For example, if we have a table of orders and each orders contains multiple
70−-- items, we could aggregate the table of orders, pairing each order with its
71−-- items:
72−--
73−-- @
74−-- ordersWithItems :: Query (Order Expr, ListTable (Item Expr))
75−-- ordersWithItems = do
76−-- order <- each orderSchema
77−-- items <- aggregate $ listAgg <$> itemsFromOrder order
78−-- return (order, items)
79−-- @
80−listAgg :: Aggregates aggregates exprs => exprs -> ListTable aggregates
81−listAgg (toColumns -> exprs) = fromColumns $
82− hvectorize
83− (\_ (Identity (DB a)) -> Aggregation $ listAggExpr a)
84− (pure exprs)
85−
86−
87−-- | Like 'listAgg', but the result is guaranteed to be a non-empty list.
88−nonEmptyAgg :: Aggregates aggregates exprs => exprs -> NonEmptyTable aggregates
89−nonEmptyAgg (toColumns -> exprs) = fromColumns $
90− hvectorize
91− (\_ (Identity (DB a)) -> Aggregation $ nonEmptyAggExpr a)
92− (pure exprs)
src/Rel8/Column.hsnew file+31
@@ -0,0 +1,31 @@
1+{-# language DataKinds #-}
2+{-# language StandaloneKindSignatures #-}
3+{-# language TypeFamilies #-}
4+
5+module Rel8.Column
6+ ( Column
7+ , TColumn
8+ )
9+where
10+
11+-- base
12+import Data.Kind ( Type )
13+import Prelude ()
14+
15+-- rel8
16+import Rel8.FCF ( Eval, Exp )
17+import qualified Rel8.Schema.Kind as K
18+import Rel8.Schema.Result ( Result )
19+
20+
21+-- | This type family is used to specify columns in 'Rel8able's. In @Column f
22+-- a@, @f@ is the context of the column (which should be left polymorphic in
23+-- 'Rel8able' definitions), and @a@ is the type of the column.
24+type Column :: K.Context -> Type -> Type
25+type family Column context a where
26+ Column Result a = a
27+ Column context a = context a
28+
29+
30+data TColumn :: K.Context -> Type -> Exp Type
31+type instance Eval (TColumn f a) = Column f a
src/Rel8/Column/ADT.hsnew file+23
@@ -0,0 +1,23 @@
1+{-# language DataKinds #-}
2+{-# language StandaloneKindSignatures #-}
3+{-# language TypeFamilies #-}
4+
5+module Rel8.Column.ADT
6+ ( HADT
7+ )
8+where
9+
10+-- base
11+import Data.Kind ( Type )
12+import Prelude ()
13+
14+-- rel8
15+import qualified Rel8.Schema.Kind as K
16+import Rel8.Schema.Result ( Result )
17+import Rel8.Table.ADT ( ADT )
18+
19+
20+type HADT :: K.Context -> K.Rel8able -> Type
21+type family HADT context t where
22+ HADT Result t = t Result
23+ HADT context t = ADT t context
src/Rel8/Column/Either.hsnew file+26
@@ -0,0 +1,26 @@
1+{-# language DataKinds #-}
2+{-# language StandaloneKindSignatures #-}
3+{-# language TypeFamilyDependencies #-}
4+
5+module Rel8.Column.Either
6+ ( HEither
7+ )
8+where
9+
10+-- base
11+import Data.Kind ( Type )
12+import Prelude
13+
14+-- rel8
15+import qualified Rel8.Schema.Kind as K
16+import Rel8.Schema.Result ( Result )
17+import Rel8.Table.Either ( EitherTable )
18+
19+
20+-- | Nest an 'Either' value within a 'Rel8able'. @HEither f a b@ will produce a
21+-- 'EitherTable' @a b@ in the 'Expr' context, and a 'Either' @a b@ in the
22+-- 'Result' context.
23+type HEither :: K.Context -> Type -> Type -> Type
24+type family HEither context = either | either -> context where
25+ HEither Result = Either
26+ HEither context = EitherTable context
src/Rel8/Column/Lift.hsnew file+23
@@ -0,0 +1,23 @@
1+{-# language DataKinds #-}
2+{-# language StandaloneKindSignatures #-}
3+{-# language TypeFamilies #-}
4+
5+module Rel8.Column.Lift
6+ ( Lift
7+ )
8+where
9+
10+-- base
11+import Data.Kind ( Type )
12+import Prelude ()
13+
14+-- rel8
15+import qualified Rel8.Schema.Kind as K
16+import Rel8.Schema.Result ( Result )
17+import Rel8.Table.HKD ( HKD )
18+
19+
20+type Lift :: K.Context -> Type -> Type
21+type family Lift context a where
22+ Lift Result a = a
23+ Lift context a = HKD a context
src/Rel8/Column/List.hsnew file+25
@@ -0,0 +1,25 @@
1+{-# language DataKinds #-}
2+{-# language StandaloneKindSignatures #-}
3+{-# language TypeFamilyDependencies #-}
4+
5+module Rel8.Column.List
6+ ( HList
7+ )
8+where
9+
10+-- base
11+import Data.Kind ( Type )
12+import Prelude ()
13+
14+-- rel8
15+import qualified Rel8.Schema.Kind as K
16+import Rel8.Schema.Result ( Result )
17+import Rel8.Table.List ( ListTable )
18+
19+
20+-- | Nest a list within a 'Rel8able'. @HList f a@ will produce a 'ListTable'
21+-- @a@ in the 'Expr' context, and a @[a]@ in the 'Result' context.
22+type HList :: K.Context -> Type -> Type
23+type family HList context = list | list -> context where
24+ HList Result = []
25+ HList context = ListTable context
src/Rel8/Column/Maybe.hsnew file+26
@@ -0,0 +1,26 @@
1+{-# language DataKinds #-}
2+{-# language StandaloneKindSignatures #-}
3+{-# language TypeFamilyDependencies #-}
4+
5+module Rel8.Column.Maybe
6+ ( HMaybe
7+ )
8+where
9+
10+-- base
11+import Data.Kind ( Type )
12+import Prelude
13+
14+-- rel8
15+import qualified Rel8.Schema.Kind as K
16+import Rel8.Schema.Result ( Result )
17+import Rel8.Table.Maybe ( MaybeTable )
18+
19+
20+-- | Nest a 'Maybe' value within a 'Rel8able'. @HMaybe f a@ will produce a
21+-- 'MaybeTable' @a@ in the 'Expr' context, and a 'Maybe' @a@ in the 'Result'
22+-- context.
23+type HMaybe :: K.Context -> Type -> Type
24+type family HMaybe context = maybe | maybe -> context where
25+ HMaybe Result = Maybe
26+ HMaybe context = MaybeTable context
src/Rel8/Column/NonEmpty.hsnew file+27
@@ -0,0 +1,27 @@
1+{-# language DataKinds #-}
2+{-# language StandaloneKindSignatures #-}
3+{-# language TypeFamilyDependencies #-}
4+
5+module Rel8.Column.NonEmpty
6+ ( HNonEmpty
7+ )
8+where
9+
10+-- base
11+import Data.Kind ( Type )
12+import Data.List.NonEmpty ( NonEmpty )
13+import Prelude ()
14+
15+-- rel8
16+import qualified Rel8.Schema.Kind as K
17+import Rel8.Schema.Result ( Result )
18+import Rel8.Table.NonEmpty ( NonEmptyTable )
19+
20+
21+-- | Nest a 'NonEmpty' list within a 'Rel8able'. @HNonEmpty f a@ will produce a
22+-- 'NonEmptyTable' @a@ in the 'Expr' context, and a 'NonEmpty' @a@ in the
23+-- 'Result' context.
24+type HNonEmpty :: K.Context -> Type -> Type
25+type family HNonEmpty context = nonEmpty | nonEmpty -> context where
26+ HNonEmpty Result = NonEmpty
27+ HNonEmpty context = NonEmptyTable context
src/Rel8/Column/Null.hsnew file+26
@@ -0,0 +1,26 @@
1+{-# language DataKinds #-}
2+{-# language StandaloneKindSignatures #-}
3+{-# language TypeFamilyDependencies #-}
4+
5+module Rel8.Column.Null
6+ ( HNull
7+ )
8+where
9+
10+-- base
11+import Data.Kind ( Type )
12+import Prelude
13+
14+-- rel8
15+import qualified Rel8.Schema.Kind as K
16+import Rel8.Schema.Result ( Result )
17+import Rel8.Table.Null ( NullTable )
18+
19+
20+-- | Nest a 'Null' value within a 'Rel8able'. @HNull f a@ will produce a
21+-- 'NullTable' @a@ in the 'Expr' context, and a @'Maybe' a@ in the 'Result'
22+-- context.
23+type HNull :: K.Context -> Type -> Type
24+type family HNull context = maybe | maybe -> context where
25+ HNull Result = Maybe
26+ HNull context = NullTable context
src/Rel8/Column/These.hsnew file+29
@@ -0,0 +1,29 @@
1+{-# language DataKinds #-}
2+{-# language StandaloneKindSignatures #-}
3+{-# language TypeFamilyDependencies #-}
4+
5+module Rel8.Column.These
6+ ( HThese
7+ )
8+where
9+
10+-- base
11+import Data.Kind ( Type )
12+import Prelude ()
13+
14+-- rel8
15+import qualified Rel8.Schema.Kind as K
16+import Rel8.Schema.Result ( Result )
17+import Rel8.Table.These ( TheseTable )
18+
19+-- these
20+import Data.These ( These )
21+
22+
23+-- | Nest an 'These' value within a 'Rel8able'. @HThese f a b@ will produce a
24+-- 'TheseTable' @a b@ in the 'Expr' context, and a 'These' @a b@ in the
25+-- 'Result' context.
26+type HThese :: K.Context -> Type -> Type -> Type
27+type family HThese context = these | these -> context where
28+ HThese Result = These
29+ HThese context = TheseTable context
src/Rel8/Expr.hs+38−46
@@ -1,27 +1,21 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2{-# language DerivingStrategies #-}
2{-# language DerivingStrategies #-}
3+{-# language FlexibleContexts #-}
3{-# language FlexibleInstances #-}
4{-# language FlexibleInstances #-}
4−{-# language GADTs #-}
5{-# language MultiParamTypeClasses #-}
5{-# language MultiParamTypeClasses #-}
6−{-# language PolyKinds #-}
7−{-# language RoleAnnotations #-}
8{-# language ScopedTypeVariables #-}
6{-# language ScopedTypeVariables #-}
9−{-# language StandaloneDeriving #-}
10{-# language StandaloneKindSignatures #-}
7{-# language StandaloneKindSignatures #-}
11{-# language TypeApplications #-}
8{-# language TypeApplications #-}
12{-# language TypeFamilies #-}
9{-# language TypeFamilies #-}
13{-# language UndecidableInstances #-}
10{-# language UndecidableInstances #-}
14−{-# language UndecidableSuperClasses #-}
15
11
16module Rel8.Expr
12module Rel8.Expr
17 ( Expr(..)
13 ( Expr(..)
18− , Col( DB, unDB )
19 )
14 )
20where
15where
21
16
22-- base
17-- base
23−import Data.Functor.Identity ( Identity )
18+import Data.Functor.Identity ( Identity( Identity ) )
24−import Data.Kind ( Type )
25import Data.String ( IsString, fromString )
19import Data.String ( IsString, fromString )
26import Prelude hiding ( null )
20import Prelude hiding ( null )
27
21
@@ -29,6 +23,7 @@ import Prelude hiding ( null )
29import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
23import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
30
24
31-- rel8
25-- rel8
26+import Rel8.Expr.Function ( function, nullaryFunction )
32import Rel8.Expr.Null ( liftOpNull, nullify )
27import Rel8.Expr.Null ( liftOpNull, nullify )
33import Rel8.Expr.Opaleye
28import Rel8.Expr.Opaleye
34 ( castExpr
29 ( castExpr
@@ -37,31 +32,24 @@ import Rel8.Expr.Opaleye
37 , zipPrimExprsWith
32 , zipPrimExprsWith
38 )
33 )
39import Rel8.Expr.Serialize ( litExpr )
34import Rel8.Expr.Serialize ( litExpr )
40−import Rel8.Schema.Context ( Interpretation, Col )
35+import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
41−import Rel8.Schema.Context.Label ( Labelable, labeler, unlabeler )
36+import qualified Rel8.Schema.Kind as K
42−import Rel8.Schema.HTable.Type ( HType( HType ) )
43import Rel8.Schema.Null ( Nullity( Null, NotNull ), Sql, nullable )
37import Rel8.Schema.Null ( Nullity( Null, NotNull ), Sql, nullable )
44−import Rel8.Schema.Reify ( notReify )
45−import Rel8.Schema.Result ( Result )
46−import Rel8.Schema.Spec ( Spec( Spec ) )
47import Rel8.Table
38import Rel8.Table
48− ( Table, Columns, Context, fromColumns, toColumns, reify, unreify
39+ ( Table, Columns, Context, fromColumns, toColumns
40+ , FromExprs, fromResult, toResult
41+ , Transpose
49 )
42 )
50−import Rel8.Table.Recontextualize ( Recontextualize )
51import Rel8.Type ( DBType )
43import Rel8.Type ( DBType )
52import Rel8.Type.Monoid ( DBMonoid, memptyExpr )
44import Rel8.Type.Monoid ( DBMonoid, memptyExpr )
53−import Rel8.Type.Num ( DBFractional, DBNum )
45+import Rel8.Type.Num ( DBFloating, DBFractional, DBNum )
54import Rel8.Type.Semigroup ( DBSemigroup, (<>.) )
46import Rel8.Type.Semigroup ( DBSemigroup, (<>.) )
55
47
56
48
57-- | Typed SQL expressions.
49-- | Typed SQL expressions.
58−type role Expr representational
50+type Expr :: K.Context
59−type Expr :: k -> Type
60−data Expr a where
61− Expr :: k ~ Type => !Opaleye.PrimExpr -> Expr (a :: k)
51+newtype Expr a = Expr Opaleye.PrimExpr
62−
63−
64−deriving stock instance Show (Expr a)
52+ deriving stock Show
65
53
66
54
67instance Sql DBSemigroup a => Semigroup (Expr a) where
55instance Sql DBSemigroup a => Semigroup (Expr a) where
@@ -104,30 +92,34 @@ instance Sql DBFractional a => Fractional (Expr a) where
104 castExpr . Expr . Opaleye.ConstExpr . Opaleye.NumericLit . realToFrac
92 castExpr . Expr . Opaleye.ConstExpr . Opaleye.NumericLit . realToFrac
105
93
106
94
107−instance Interpretation Expr where
95+instance Sql DBFloating a => Floating (Expr a) where
108− data Col Expr _spec where
96+ pi = nullaryFunction "PI"
109− DB :: {unDB :: Expr a} -> Col Expr ('Spec labels necessity a)
97+ exp = function "exp"
98+ log = function "ln"
99+ sqrt = function "sqrt"
100+ (**) = zipPrimExprsWith (Opaleye.BinExpr (Opaleye.:^))
101+ logBase = function "log"
102+ sin = function "sin"
103+ cos = function "cos"
104+ tan = function "tan"
105+ asin = function "asin"
106+ acos = function "acos"
107+ atan = function "atan"
108+ sinh = function "sinh"
109+ cosh = function "cosh"
110+ tanh = function "tanh"
111+ asinh = function "asinh"
112+ acosh = function "acosh"
113+ atanh = function "atanh"
110
114
111
115
112instance Sql DBType a => Table Expr (Expr a) where
116instance Sql DBType a => Table Expr (Expr a) where
113− type Columns (Expr a) = HType a
117+ type Columns (Expr a) = HIdentity a
114 type Context (Expr a) = Expr
118 type Context (Expr a) = Expr
119+ type FromExprs (Expr a) = a
120+ type Transpose to (Expr a) = to a
115
121
116− toColumns a = HType (DB a)
122+ toColumns a = HIdentity a
117− fromColumns (HType (DB a)) = a
123+ fromColumns (HIdentity a) = a
118− reify = notReify
124+ toResult a = HIdentity (Identity a)
119− unreify = notReify
125+ fromResult (HIdentity (Identity a)) = a
120−
121−
122−instance Sql DBType a => Recontextualize Expr Expr (Expr a) (Expr a)
123−
124−
125−instance Sql DBType a => Recontextualize Expr Result (Expr a) (Identity a)
126−
127−
128−instance Sql DBType a => Recontextualize Result Expr (Identity a) (Expr a)
129−
130−
131−instance Labelable Expr where
132− labeler (DB a) = DB a
133− unlabeler (DB a) = DB a
src/Rel8/Expr.hs-boot+6−8
@@ -1,6 +1,4 @@
1−{-# language GADTs #-}
1+{-# language DataKinds #-}
2−{-# language PolyKinds #-}
3−{-# language RoleAnnotations #-}
4{-# language StandaloneKindSignatures #-}
2{-# language StandaloneKindSignatures #-}
5
3
6module Rel8.Expr
4module Rel8.Expr
@@ -9,14 +7,14 @@ module Rel8.Expr
9where
7where
10
8
11-- base
9-- base
12−import Data.Kind ( Type )
13import Prelude ()
10import Prelude ()
14
11
15-- opaleye
12-- opaleye
16import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
13import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
17
14
15+-- rel8
16+import Rel8.Schema.Kind ( Context )
18
17
19−type role Expr representational
18+
20−type Expr :: k -> Type
19+type Expr :: Context
21−data Expr a where
22− Expr :: k ~ Type => !Opaleye.PrimExpr -> Expr (a :: k)
20+newtype Expr a = Expr Opaleye.PrimExpr
src/Rel8/Expr/Aggregate.hs+53−115
@@ -10,10 +10,11 @@ module Rel8.Expr.Aggregate
10 , and, or
10 , and, or
11 , min, max
11 , min, max
12 , sum, sumWhere
12 , sum, sumWhere
13+ , avg
13 , stringAgg
14 , stringAgg
14 , groupByExpr
15 , groupByExpr
15− , array1DAggExpr, listAggExpr, nonEmptyAggExpr
16+ , listAggExpr, nonEmptyAggExpr
16− , listAggExprWithOrder, nonEmptyAggExprWithOrder
17+ , slistAggExpr, snonEmptyAggExpr
17 )
18 )
18where
19where
19
20
@@ -23,10 +24,12 @@ import Data.List.NonEmpty ( NonEmpty )
23import Prelude hiding ( and, max, min, null, or, sum )
24import Prelude hiding ( and, max, min, null, or, sum )
24
25
25-- opaleye
26-- opaleye
26−import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
27+import qualified Opaleye.Internal.Aggregate as Opaleye
28+import Opaleye.Internal.Column ( Field_( Column ) )
29+import qualified Opaleye.Aggregate as Opaleye
27
30
28-- rel8
31-- rel8
29−import Rel8.Aggregate ( Aggregate, Aggregator(..), unsafeMakeAggregate )
32+import Rel8.Aggregate ( Aggregate, unsafeMakeAggregate )
30import Rel8.Expr ( Expr )
33import Rel8.Expr ( Expr )
31import Rel8.Expr.Bool ( caseExpr )
34import Rel8.Expr.Bool ( caseExpr )
32import Rel8.Expr.Opaleye
35import Rel8.Expr.Opaleye
@@ -37,11 +40,11 @@ import Rel8.Expr.Opaleye
37 )
40 )
38import Rel8.Expr.Null ( null )
41import Rel8.Expr.Null ( null )
39import Rel8.Expr.Serialize ( litExpr )
42import Rel8.Expr.Serialize ( litExpr )
40−import Rel8.Order ( Order, toOrderExprs )
41−import Rel8.Schema.Null ( Sql )
43+import Rel8.Schema.Null ( Sql, Unnullify )
44+import Rel8.Type ( DBType, typeInformation )
42−import Rel8.Type.Array ( fromPrimArray )
45+import Rel8.Type.Array ( encodeArrayElement )
43−import Rel8.Type.Array1D ( Array1D, NotArray )
44import Rel8.Type.Eq ( DBEq )
46import Rel8.Type.Eq ( DBEq )
47+import Rel8.Type.Information ( TypeInformation )
45import Rel8.Type.Num ( DBNum )
48import Rel8.Type.Num ( DBNum )
46import Rel8.Type.Ord ( DBMax, DBMin )
49import Rel8.Type.Ord ( DBMax, DBMin )
47import Rel8.Type.String ( DBString )
50import Rel8.Type.String ( DBString )
@@ -49,164 +52,99 @@ import Rel8.Type.Sum ( DBSum )
49
52
50
53
51-- | Count the occurances of a single column. Corresponds to @COUNT(a)@
54-- | Count the occurances of a single column. Corresponds to @COUNT(a)@
52−count :: Expr a -> Aggregate (Expr Int64)
55+count :: Expr a -> Aggregate Int64
53−count = unsafeMakeAggregate toPrimExpr fromPrimExpr $
56+count = unsafeMakeAggregate toPrimExpr fromPrimExpr Opaleye.count
54− Just Aggregator
55− { operation = Opaleye.AggrCount
56− , ordering = []
57− , distinction = Opaleye.AggrAll
58− }
59−
60
57
61-- | Count the number of distinct occurances of a single column. Corresponds to
58-- | Count the number of distinct occurances of a single column. Corresponds to
62-- @COUNT(DISTINCT a)@
59-- @COUNT(DISTINCT a)@
63−countDistinct :: Sql DBEq a => Expr a -> Aggregate (Expr Int64)
60+countDistinct :: Sql DBEq a => Expr a -> Aggregate Int64
64countDistinct = unsafeMakeAggregate toPrimExpr fromPrimExpr $
61countDistinct = unsafeMakeAggregate toPrimExpr fromPrimExpr $
65− Just Aggregator
62+ Opaleye.distinctAggregator Opaleye.count
66− { operation = Opaleye.AggrCount
67− , ordering = []
68− , distinction = Opaleye.AggrDistinct
69− }
70
63
71
64
72-- | Corresponds to @COUNT(*)@.
65-- | Corresponds to @COUNT(*)@.
73−countStar :: Aggregate (Expr Int64)
66+countStar :: Aggregate Int64
74countStar = count (litExpr True)
67countStar = count (litExpr True)
75
68
76
69
77-- | A count of the number of times a given expression is @true@.
70-- | A count of the number of times a given expression is @true@.
78−countWhere :: Expr Bool -> Aggregate (Expr Int64)
71+countWhere :: Expr Bool -> Aggregate Int64
79countWhere condition = count (caseExpr [(condition, litExpr (Just True))] null)
72countWhere condition = count (caseExpr [(condition, litExpr (Just True))] null)
80
73
81
74
82-- | Corresponds to @bool_and@.
75-- | Corresponds to @bool_and@.
83−and :: Expr Bool -> Aggregate (Expr Bool)
76+and :: Expr Bool -> Aggregate Bool
84−and = unsafeMakeAggregate toPrimExpr fromPrimExpr $
77+and = unsafeMakeAggregate toPrimExpr fromPrimExpr Opaleye.boolAnd
85− Just Aggregator
86− { operation = Opaleye.AggrBoolAnd
87− , ordering = []
88− , distinction = Opaleye.AggrAll
89− }
90
78
91
79
92-- | Corresponds to @bool_or@.
80-- | Corresponds to @bool_or@.
93−or :: Expr Bool -> Aggregate (Expr Bool)
81+or :: Expr Bool -> Aggregate Bool
94−or = unsafeMakeAggregate toPrimExpr fromPrimExpr $
82+or = unsafeMakeAggregate toPrimExpr fromPrimExpr Opaleye.boolOr
95− Just Aggregator
96− { operation = Opaleye.AggrBoolOr
97− , ordering = []
98− , distinction = Opaleye.AggrAll
99− }
100
83
101
84
102-- | Produce an aggregation for @Expr a@ using the @max@ function.
85-- | Produce an aggregation for @Expr a@ using the @max@ function.
103−max :: Sql DBMax a => Expr a -> Aggregate (Expr a)
86+max :: Sql DBMax a => Expr a -> Aggregate a
104−max = unsafeMakeAggregate toPrimExpr fromPrimExpr $
87+max = unsafeMakeAggregate toPrimExpr fromPrimExpr Opaleye.unsafeMax
105− Just Aggregator
106− { operation = Opaleye.AggrMax
107− , ordering = []
108− , distinction = Opaleye.AggrAll
109− }
110
88
111
89
112-- | Produce an aggregation for @Expr a@ using the @max@ function.
90-- | Produce an aggregation for @Expr a@ using the @max@ function.
113−min :: Sql DBMin a => Expr a -> Aggregate (Expr a)
91+min :: Sql DBMin a => Expr a -> Aggregate a
114−min = unsafeMakeAggregate toPrimExpr fromPrimExpr $
92+min = unsafeMakeAggregate toPrimExpr fromPrimExpr Opaleye.unsafeMin
115− Just Aggregator
116− { operation = Opaleye.AggrMin
117− , ordering = []
118− , distinction = Opaleye.AggrAll
119− }
120
93
121-- | Corresponds to @sum@. Note that in SQL, @sum@ is type changing - for
94-- | Corresponds to @sum@. Note that in SQL, @sum@ is type changing - for
122-- example the @sum@ of @integer@ returns a @bigint@. Rel8 doesn't support
95-- example the @sum@ of @integer@ returns a @bigint@. Rel8 doesn't support
123−-- this, and will add explicit cast back to the original input type. This can
96+-- this, and will add explicit casts back to the original input type. This can
124-- lead to overflows, and if you anticipate very large sums, you should upcast
97-- lead to overflows, and if you anticipate very large sums, you should upcast
125-- your input.
98-- your input.
126−sum :: Sql DBSum a => Expr a -> Aggregate (Expr a)
99+sum :: Sql DBSum a => Expr a -> Aggregate a
127−sum = unsafeMakeAggregate toPrimExpr (castExpr . fromPrimExpr) $
100+sum = unsafeMakeAggregate toPrimExpr (castExpr . fromPrimExpr) Opaleye.unsafeSum
128− Just Aggregator
101+
129− { operation = Opaleye.AggrSum
130− , ordering = []
131− , distinction = Opaleye.AggrAll
132− }
133
102
103+-- | Corresponds to @avg@. Note that in SQL, @avg@ is type changing - for
104+-- example, the @avg@ of @integer@ returns a @numeric@. Rel8 doesn't support
105+-- this, and will add explicit casts back to the original input type. If you
106+-- need a fractional result on an integral column, you should cast your input
107+-- to 'Double' or 'Data.Scientific.Scientific' before calling 'avg'.
108+avg :: Sql DBSum a => Expr a -> Aggregate a
109+avg = unsafeMakeAggregate toPrimExpr (castExpr . fromPrimExpr) Opaleye.unsafeAvg
134
110
135-- | Take the sum of all expressions that satisfy a predicate.
111-- | Take the sum of all expressions that satisfy a predicate.
136sumWhere :: (Sql DBNum a, Sql DBSum a)
112sumWhere :: (Sql DBNum a, Sql DBSum a)
137− => Expr Bool -> Expr a -> Aggregate (Expr a)
113+ => Expr Bool -> Expr a -> Aggregate a
138sumWhere condition a = sum (caseExpr [(condition, a)] 0)
114sumWhere condition a = sum (caseExpr [(condition, a)] 0)
139
115
140
116
141-- | Corresponds to @string_agg()@.
117-- | Corresponds to @string_agg()@.
142stringAgg :: Sql DBString a
118stringAgg :: Sql DBString a
143− => Expr db -> Expr a -> Aggregate (Expr a)
119+ => Expr db -> Expr a -> Aggregate a
144stringAgg delimiter =
120stringAgg delimiter =
145− unsafeMakeAggregate toPrimExpr (castExpr . fromPrimExpr) $
121+ unsafeMakeAggregate toPrimExpr (castExpr . fromPrimExpr) (Opaleye.stringAgg (Column (toPrimExpr delimiter)))
146− Just Aggregator
147− { operation = Opaleye.AggrStringAggr (toPrimExpr delimiter)
148− , ordering = []
149− , distinction = Opaleye.AggrAll
150− }
151
122
152
123
153-- | Aggregate a value by grouping by it.
124-- | Aggregate a value by grouping by it.
154−groupByExpr :: Sql DBEq a => Expr a -> Aggregate (Expr a)
125+groupByExpr :: Sql DBEq a => Expr a -> Aggregate a
155−groupByExpr = unsafeMakeAggregate toPrimExpr fromPrimExpr Nothing
126+groupByExpr = unsafeMakeAggregate toPrimExpr fromPrimExpr Opaleye.groupBy
156−
157−
158−-- | Collect expressions values as an array.
159−array1DAggExpr :: NotArray a => Expr a -> Aggregate (Expr (Array1D a))
160−array1DAggExpr = unsafeMakeAggregate toPrimExpr fromPrimExpr $ Just
161− Aggregator
162− { operation = Opaleye.AggrArr
163− , ordering = []
164− , distinction = Opaleye.AggrAll
165− }
166
127
167
128
168-- | Collect expressions values as a list.
129-- | Collect expressions values as a list.
169−listAggExpr :: Expr a -> Aggregate (Expr [a])
130+listAggExpr :: Sql DBType a => Expr a -> Aggregate [a]
170−listAggExpr = unsafeMakeAggregate toPrimExpr from $ Just
131+listAggExpr = slistAggExpr typeInformation
171− Aggregator
172− { operation = Opaleye.AggrArr
173− , ordering = []
174− , distinction = Opaleye.AggrAll
175− }
176− where
177− from = fromPrimExpr . fromPrimArray
178
132
179
133
180-- | Collect expressions values as a non-empty list.
134-- | Collect expressions values as a non-empty list.
181−nonEmptyAggExpr :: Expr a -> Aggregate (Expr (NonEmpty a))
135+nonEmptyAggExpr :: Sql DBType a => Expr a -> Aggregate (NonEmpty a)
182−nonEmptyAggExpr = unsafeMakeAggregate toPrimExpr from $ Just
136+nonEmptyAggExpr = snonEmptyAggExpr typeInformation
183− Aggregator
184− { operation = Opaleye.AggrArr
185− , ordering = []
186− , distinction = Opaleye.AggrAll
187− }
188− where
189− from = fromPrimExpr . fromPrimArray
190
137
191
138
192−listAggExprWithOrder :: Order o -> o -> Expr a -> Aggregate (Expr [a])
139+slistAggExpr :: ()
193−listAggExprWithOrder order o = unsafeMakeAggregate toPrimExpr from $ Just
140+ => TypeInformation (Unnullify a) -> Expr a -> Aggregate [a]
194− Aggregator
141+slistAggExpr info = unsafeMakeAggregate to fromPrimExpr Opaleye.arrayAgg
195− { operation = Opaleye.AggrArr
196− , ordering = toOrderExprs order o
197− , distinction = Opaleye.AggrAll
198− }
199 where
142 where
200− from = fromPrimExpr . fromPrimArray
143+ to = encodeArrayElement info . toPrimExpr
201
144
202
145
203−nonEmptyAggExprWithOrder :: ()
146+snonEmptyAggExpr :: ()
204− => Order o -> o -> Expr a -> Aggregate (Expr (NonEmpty a))
147+ => TypeInformation (Unnullify a) -> Expr a -> Aggregate (NonEmpty a)
205−nonEmptyAggExprWithOrder order o = unsafeMakeAggregate toPrimExpr from $ Just
148+snonEmptyAggExpr info = unsafeMakeAggregate to fromPrimExpr Opaleye.arrayAgg
206− Aggregator
207− { operation = Opaleye.AggrArr
208− , ordering = toOrderExprs order o
209− , distinction = Opaleye.AggrAll
210− }
211 where
149 where
212− from = fromPrimExpr . fromPrimArray
150+ to = encodeArrayElement info . toPrimExpr
src/Rel8/Expr/Array.hs+6−6
@@ -25,21 +25,21 @@ import Rel8.Expr.Opaleye
25 , zipPrimExprsWith
25 , zipPrimExprsWith
26 )
26 )
27import Rel8.Type ( DBType, typeInformation )
27import Rel8.Type ( DBType, typeInformation )
28−import Rel8.Type.Array ( array, zipPrimArraysWith )
28+import Rel8.Type.Array ( array )
29import Rel8.Type.Information ( TypeInformation(..) )
29import Rel8.Type.Information ( TypeInformation(..) )
30−import Rel8.Schema.Null ( Unnullify, Nullity, Sql )
30+import Rel8.Schema.Null ( Unnullify, Sql )
31
31
32
32
33sappend :: Expr [a] -> Expr [a] -> Expr [a]
33sappend :: Expr [a] -> Expr [a] -> Expr [a]
34−sappend = zipPrimExprsWith (zipPrimArraysWith (Opaleye.BinExpr (Opaleye.:||)))
34+sappend = zipPrimExprsWith (Opaleye.BinExpr (Opaleye.:||))
35
35
36
36
37sappend1 :: Expr (NonEmpty a) -> Expr (NonEmpty a) -> Expr (NonEmpty a)
37sappend1 :: Expr (NonEmpty a) -> Expr (NonEmpty a) -> Expr (NonEmpty a)
38−sappend1 = zipPrimExprsWith (zipPrimArraysWith (Opaleye.BinExpr (Opaleye.:||)))
38+sappend1 = zipPrimExprsWith (Opaleye.BinExpr (Opaleye.:||))
39
39
40
40
41−sempty :: Nullity a -> TypeInformation (Unnullify a) -> Expr [a]
41+sempty :: TypeInformation (Unnullify a) -> Expr [a]
42−sempty _ info = fromPrimExpr $ array info []
42+sempty info = fromPrimExpr $ array info []
43
43
44
44
45slistOf :: TypeInformation (Unnullify a) -> [Expr a] -> Expr [a]
45slistOf :: TypeInformation (Unnullify a) -> [Expr a] -> Expr [a]
src/Rel8/Expr/Default.hsnew file+35
@@ -0,0 +1,35 @@
1+module Rel8.Expr.Default
2+ ( unsafeDefault
3+ )
4+where
5+
6+-- base
7+import Prelude ()
8+
9+-- opaleye
10+import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
11+
12+-- rel8
13+import Rel8.Expr ( Expr )
14+import Rel8.Expr.Opaleye ( fromPrimExpr )
15+
16+
17+-- | Corresponds to the SQL @DEFAULT@ expression.
18+--
19+-- This 'Expr' is unsafe for numerous reasons, and should be used with care:
20+--
21+-- 1. This 'Expr' only makes sense in an @INSERT@ or @UPDATE@ statement.
22+--
23+-- 2. Rel8 is not able to verify that a particular column actually has a
24+-- @DEFAULT@ value. Trying to use @unsafeDefault@ where there is no default
25+-- will cause a runtime crash
26+--
27+-- 3. @DEFAULT@ values can not be transformed. For example, the innocuous Rel8
28+-- code @unsafeDefault + 1@ will crash, despite type checking.
29+--
30+-- Given all these caveats, we suggest avoiding the use of default values where
31+-- possible, instead being explicit. A common scenario where default values are
32+-- used is with auto-incrementing identifier columns. In this case, we suggest
33+-- using 'Rel8.nextval' instead.
34+unsafeDefault :: Expr a
35+unsafeDefault = fromPrimExpr Opaleye.DefaultInsertExpr
src/Rel8/Expr/Eq.hs+1−1
@@ -22,7 +22,7 @@ import Prelude
22import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
22import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
23
23
24-- rel8
24-- rel8
25−import {-# SOURCE #-} Rel8.Expr ( Expr )
25+import Rel8.Expr ( Expr )
26import Rel8.Expr.Bool ( (&&.), (||.), false, or_, coalesce )
26import Rel8.Expr.Bool ( (&&.), (||.), false, or_, coalesce )
27import Rel8.Expr.Null ( isNull, unsafeLiftOpNull )
27import Rel8.Expr.Null ( isNull, unsafeLiftOpNull )
28import Rel8.Expr.Opaleye ( fromPrimExpr, toPrimExpr, zipPrimExprsWith )
28import Rel8.Expr.Opaleye ( fromPrimExpr, toPrimExpr, zipPrimExprsWith )
src/Rel8/Expr/Function.hs+1−1
@@ -20,7 +20,7 @@ import Prelude
20import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
20import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
21
21
22-- rel8
22-- rel8
23−import Rel8.Expr ( Expr( Expr ) )
23+import {-# SOURCE #-} Rel8.Expr ( Expr( Expr ) )
24import Rel8.Expr.Opaleye
24import Rel8.Expr.Opaleye
25 ( castExpr
25 ( castExpr
26 , fromPrimExpr, toPrimExpr, zipPrimExprsWith
26 , fromPrimExpr, toPrimExpr, zipPrimExprsWith
src/Rel8/Expr/Null.hs+3−3
@@ -5,7 +5,7 @@
5{-# options -fno-warn-redundant-constraints #-}
5{-# options -fno-warn-redundant-constraints #-}
6
6
7module Rel8.Expr.Null
7module Rel8.Expr.Null
8− ( null, snull, nullable, nullableOf
8+ ( null, snull, nullableExpr, nullableOf
9 , isNull, isNonNull
9 , isNull, isNonNull
10 , nullify, unsafeUnnullify
10 , nullify, unsafeUnnullify
11 , mapNull, liftOpNull
11 , mapNull, liftOpNull
@@ -40,8 +40,8 @@ unsafeUnnullify (Expr a) = Expr a
40
40
41
41
42-- | Like 'maybe', but to eliminate @null@.
42-- | Like 'maybe', but to eliminate @null@.
43−nullable :: Expr b -> (Expr a -> Expr b) -> Expr (Maybe a) -> Expr b
43+nullableExpr :: Expr b -> (Expr a -> Expr b) -> Expr (Maybe a) -> Expr b
44−nullable b f ma = boolExpr (f (unsafeUnnullify ma)) b (isNull ma)
44+nullableExpr b f ma = boolExpr (f (unsafeUnnullify ma)) b (isNull ma)
45
45
46
46
47nullableOf :: DBType a => Maybe (Expr a) -> Expr (Maybe a)
47nullableOf :: DBType a => Maybe (Expr a) -> Expr (Maybe a)
src/Rel8/Expr/Num.hs+43−10
@@ -4,18 +4,24 @@
4{-# options_ghc -fno-warn-redundant-constraints #-}
4{-# options_ghc -fno-warn-redundant-constraints #-}
5
5
6module Rel8.Expr.Num
6module Rel8.Expr.Num
7+ ( fromIntegral
8+ , realToFrac
9+ , div, mod, divMod
10+ , quot, rem, quotRem
7− ( fromIntegral, realToFrac, div, mod, ceiling, floor, round, truncate
11+ , ceiling, floor, round, truncate
8 )
12 )
9where
13where
10
14
11-- base
15-- base
12−import Prelude ()
16+import Prelude ( (+), (-), fst, negate, signum, snd )
13
17
14-- rel
18-- rel
15import Rel8.Expr ( Expr( Expr ) )
19import Rel8.Expr ( Expr( Expr ) )
20+import Rel8.Expr.Eq ( (==.) )
16import Rel8.Expr.Function ( function )
21import Rel8.Expr.Function ( function )
17import Rel8.Expr.Opaleye ( castExpr )
22import Rel8.Expr.Opaleye ( castExpr )
18import Rel8.Schema.Null ( Homonullable, Sql )
23import Rel8.Schema.Null ( Homonullable, Sql )
24+import Rel8.Table.Bool ( bool )
19import Rel8.Type.Num ( DBFractional, DBIntegral, DBNum )
25import Rel8.Type.Num ( DBFractional, DBIntegral, DBNum )
20
26
21
27
@@ -39,17 +45,44 @@ realToFrac (Expr a) = castExpr (Expr a)
39-- Corresponds to the @ceiling()@ function.
45-- Corresponds to the @ceiling()@ function.
40ceiling :: (Sql DBFractional a, Sql DBIntegral b, Homonullable a b)
46ceiling :: (Sql DBFractional a, Sql DBIntegral b, Homonullable a b)
41 => Expr a -> Expr b
47 => Expr a -> Expr b
42−ceiling = function "CEILING"
48+ceiling = function "ceiling"
43
49
44
50
45−-- | Perform integral division. Corresponds to the @div()@ function.
51+-- | Emulates the behaviour of the Haskell function 'Prelude.div' in
52+-- PostgreSQL.
46div :: Sql DBIntegral a => Expr a -> Expr a -> Expr a
53div :: Sql DBIntegral a => Expr a -> Expr a -> Expr a
47−div = function "DIV"
54+div n d = fst (divMod n d)
48
55
49
56
50−-- | Corresponds to the @mod()@ function.
57+-- | Emulates the behaviour of the Haskell function 'Prelude.mod' in
58+-- PostgreSQL.
51mod :: Sql DBIntegral a => Expr a -> Expr a -> Expr a
59mod :: Sql DBIntegral a => Expr a -> Expr a -> Expr a
52−mod = function "MOD"
60+mod n d = snd (divMod n d)
61+
62+
63+-- | Simultaneous 'div' and 'mod'.
64+divMod :: Sql DBIntegral a => Expr a -> Expr a -> (Expr a, Expr a)
65+divMod n d = bool qr (q - 1, r + d) (signum r ==. negate (signum d))
66+ where
67+ qr@(q, r) = quotRem n d
68+
69+
70+-- | Perform integral division. Corresponds to the @div()@ function in
71+-- PostgreSQL, which behaves like Haskell's 'Prelude.quot' rather than
72+-- 'Prelude.div'.
73+quot :: Sql DBIntegral a => Expr a -> Expr a -> Expr a
74+quot = function "div"
75+
76+
77+-- | Corresponds to the @mod()@ function in PostgreSQL, which behaves like
78+-- Haskell's 'Prelude.rem' rather than 'Prelude.mod'.
79+rem :: Sql DBIntegral a => Expr a -> Expr a -> Expr a
80+rem = function "mod"
81+
82+
83+-- | Simultaneous 'quot' and 'rem'.
84+quotRem :: Sql DBIntegral a => Expr a -> Expr a -> (Expr a, Expr a)
85+quotRem n d = (quot n d, rem n d)
53
86
54
87
55-- | Round a 'DFractional' to a 'DBIntegral' by rounding to the nearest smaller
88-- | Round a 'DFractional' to a 'DBIntegral' by rounding to the nearest smaller
@@ -58,7 +91,7 @@ mod = function "MOD"
58-- Corresponds to the @floor()@ function.
91-- Corresponds to the @floor()@ function.
59floor :: (Sql DBFractional a, Sql DBIntegral b, Homonullable a b)
92floor :: (Sql DBFractional a, Sql DBIntegral b, Homonullable a b)
60 => Expr a -> Expr b
93 => Expr a -> Expr b
61−floor = function "FLOOR"
94+floor = function "floor"
62
95
63
96
64-- | Round a 'DBFractional' to a 'DBIntegral' by rounding to the nearest
97-- | Round a 'DBFractional' to a 'DBIntegral' by rounding to the nearest
@@ -67,11 +100,11 @@ floor = function "FLOOR"
67-- Corresponds to the @round()@ function.
100-- Corresponds to the @round()@ function.
68round :: (Sql DBFractional a, Sql DBIntegral b, Homonullable a b)
101round :: (Sql DBFractional a, Sql DBIntegral b, Homonullable a b)
69 => Expr a -> Expr b
102 => Expr a -> Expr b
70−round = function "ROUND"
103+round = function "round"
71
104
72
105
73-- | Round a 'DBFractional' to a 'DBIntegral' by rounding to the nearest
106-- | Round a 'DBFractional' to a 'DBIntegral' by rounding to the nearest
74-- integer towards zero.
107-- integer towards zero.
75truncate :: (Sql DBFractional a, Sql DBIntegral b, Homonullable a b)
108truncate :: (Sql DBFractional a, Sql DBIntegral b, Homonullable a b)
76 => Expr a -> Expr b
109 => Expr a -> Expr b
77−truncate = function "TRUNC"
110+truncate = function "trunc"
src/Rel8/Expr/Opaleye.hs+19−5
@@ -10,7 +10,7 @@ module Rel8.Expr.Opaleye
10 , scastExpr, sunsafeCastExpr
10 , scastExpr, sunsafeCastExpr
11 , unsafeLiteral
11 , unsafeLiteral
12 , fromPrimExpr, toPrimExpr, mapPrimExpr, zipPrimExprsWith, traversePrimExpr
12 , fromPrimExpr, toPrimExpr, mapPrimExpr, zipPrimExprsWith, traversePrimExpr
13− , toColumn, fromColumn
13+ , toColumn, fromColumn, traverseFieldP
14 )
14 )
15where
15where
16
16
@@ -27,6 +27,9 @@ import Rel8.Schema.Null ( Unnullify, Sql )
27import Rel8.Type ( DBType, typeInformation )
27import Rel8.Type ( DBType, typeInformation )
28import Rel8.Type.Information ( TypeInformation(..) )
28import Rel8.Type.Information ( TypeInformation(..) )
29
29
30+-- profunctors
31+import Data.Profunctor ( Profunctor, dimap )
32+
30
33
31castExpr :: Sql DBType a => Expr a -> Expr a
34castExpr :: Sql DBType a => Expr a -> Expr a
32castExpr = scastExpr typeInformation
35castExpr = scastExpr typeInformation
@@ -48,8 +51,13 @@ sunsafeCastExpr TypeInformation {typeName} =
48 fromPrimExpr . Opaleye.CastExpr typeName . toPrimExpr
51 fromPrimExpr . Opaleye.CastExpr typeName . toPrimExpr
49
52
50
53
54+-- | Unsafely construct an expression from literal SQL.
55+--
56+-- This is an escape hatch, and can be used if Rel8 can not adequately express
57+-- the query you need. If you find yourself using this function, please let us
58+-- know, as it may indicate that something is missing from Rel8!
51−unsafeLiteral :: Sql DBType a => String -> Expr a
59+unsafeLiteral :: String -> Expr a
52−unsafeLiteral = castExpr . Expr . Opaleye.ConstExpr . Opaleye.OtherLit
60+unsafeLiteral = Expr . Opaleye.ConstExpr . Opaleye.OtherLit
53
61
54
62
55fromPrimExpr :: Opaleye.PrimExpr -> Expr a
63fromPrimExpr :: Opaleye.PrimExpr -> Expr a
@@ -75,9 +83,15 @@ traversePrimExpr :: Functor f
75traversePrimExpr f = fmap fromPrimExpr . f . toPrimExpr
83traversePrimExpr f = fmap fromPrimExpr . f . toPrimExpr
76
84
77
85
86+traverseFieldP :: Profunctor p
87+ => p (Opaleye.Field_ n x) (Opaleye.Field_ m y)
88+ -> p (Expr a) (Expr b)
89+traverseFieldP = dimap (toColumn . toPrimExpr) (fromPrimExpr . fromColumn)
90+
91+
78−toColumn :: Opaleye.PrimExpr -> Opaleye.Column b
92+toColumn :: Opaleye.PrimExpr -> Opaleye.Field_ n b
79toColumn = Opaleye.Column
93toColumn = Opaleye.Column
80
94
81
95
82−fromColumn :: Opaleye.Column b -> Opaleye.PrimExpr
96+fromColumn :: Opaleye.Field_ n b -> Opaleye.PrimExpr
83fromColumn (Opaleye.Column a) = a
97fromColumn (Opaleye.Column a) = a
src/Rel8/Expr/Ord.hs+10−11
@@ -22,10 +22,9 @@ import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
22-- rel8
22-- rel8
23import Rel8.Expr ( Expr( Expr ) )
23import Rel8.Expr ( Expr( Expr ) )
24import Rel8.Expr.Bool ( (&&.), (||.), coalesce )
24import Rel8.Expr.Bool ( (&&.), (||.), coalesce )
25−import Rel8.Expr.Null ( isNull, isNonNull, nullable, unsafeLiftOpNull )
25+import Rel8.Expr.Null ( isNull, isNonNull, nullableExpr, unsafeLiftOpNull )
26import Rel8.Expr.Opaleye ( toPrimExpr, zipPrimExprsWith )
26import Rel8.Expr.Opaleye ( toPrimExpr, zipPrimExprsWith )
27−import Rel8.Schema.Null ( Nullity( Null, NotNull ), Sql )
27+import Rel8.Schema.Null ( Nullity( Null, NotNull ), Sql, nullable )
28−import qualified Rel8.Schema.Null as Schema ( nullable )
29import Rel8.Type.Ord ( DBOrd )
28import Rel8.Type.Ord ( DBOrd )
30
29
31
30
@@ -49,7 +48,7 @@ ge = zipPrimExprsWith (Opaleye.BinExpr (Opaleye.:>=))
49-- as @null@ will sort below any other value. For a version of @<@ that exactly
48-- as @null@ will sort below any other value. For a version of @<@ that exactly
50-- matches SQL, see '(<?)'.
49-- matches SQL, see '(<?)'.
51(<.) :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr Bool
50(<.) :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr Bool
52−(<.) = case Schema.nullable @a of
51+(<.) = case nullable @a of
53 Null -> \ma mb -> isNull ma &&. isNonNull mb ||. ma <? mb
52 Null -> \ma mb -> isNull ma &&. isNonNull mb ||. ma <? mb
54 NotNull -> lt
53 NotNull -> lt
55infix 4 <.
54infix 4 <.
@@ -59,7 +58,7 @@ infix 4 <.
59-- as @null@ will sort below any other value. For a version of @<=@ that exactly
58-- as @null@ will sort below any other value. For a version of @<=@ that exactly
60-- matches SQL, see '(<=?)'.
59-- matches SQL, see '(<=?)'.
61(<=.) :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr Bool
60(<=.) :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr Bool
62−(<=.) = case Schema.nullable @a of
61+(<=.) = case nullable @a of
63 Null -> \ma mb -> isNull ma ||. ma <=? mb
62 Null -> \ma mb -> isNull ma ||. ma <=? mb
64 NotNull -> le
63 NotNull -> le
65infix 4 <=.
64infix 4 <=.
@@ -69,7 +68,7 @@ infix 4 <=.
69-- as @null@ will sort below any other value. For a version of @>@ that exactly
68-- as @null@ will sort below any other value. For a version of @>@ that exactly
70-- matches SQL, see '(>?)'.
69-- matches SQL, see '(>?)'.
71(>.) :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr Bool
70(>.) :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr Bool
72−(>.) = case Schema.nullable @a of
71+(>.) = case nullable @a of
73 Null -> \ma mb -> isNonNull ma &&. isNull mb ||. ma >? mb
72 Null -> \ma mb -> isNonNull ma &&. isNull mb ||. ma >? mb
74 NotNull -> gt
73 NotNull -> gt
75infix 4 >.
74infix 4 >.
@@ -79,7 +78,7 @@ infix 4 >.
79-- as @null@ will sort below any other value. For a version of @>=@ that
78-- as @null@ will sort below any other value. For a version of @>=@ that
80-- exactly matches SQL, see '(>=?)'.
79-- exactly matches SQL, see '(>=?)'.
81(>=.) :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr Bool
80(>=.) :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr Bool
82−(>=.) = case Schema.nullable @a of
81+(>=.) = case nullable @a of
83 Null -> \ma mb -> isNull mb ||. ma >=? mb
82 Null -> \ma mb -> isNull mb ||. ma >=? mb
84 NotNull -> ge
83 NotNull -> ge
85infix 4 >=.
84infix 4 >=.
@@ -118,8 +117,8 @@ infix 4 >=?
118--
117--
119-- Corresponds to the SQL @least()@ function.
118-- Corresponds to the SQL @least()@ function.
120leastExpr :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr a
119leastExpr :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr a
121−leastExpr ma mb = case Schema.nullable @a of
120+leastExpr ma mb = case nullable @a of
122− Null -> nullable ma (\a -> nullable mb (least_ a) mb) ma
121+ Null -> nullableExpr ma (\a -> nullableExpr mb (least_ a) mb) ma
123 NotNull -> least_ ma mb
122 NotNull -> least_ ma mb
124 where
123 where
125 least_ a b = Expr (Opaleye.FunExpr "LEAST" [toPrimExpr a, toPrimExpr b])
124 least_ a b = Expr (Opaleye.FunExpr "LEAST" [toPrimExpr a, toPrimExpr b])
@@ -130,8 +129,8 @@ leastExpr ma mb = case Schema.nullable @a of
130--
129--
131-- Corresponds to the SQL @greatest()@ function.
130-- Corresponds to the SQL @greatest()@ function.
132greatestExpr :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr a
131greatestExpr :: forall a. Sql DBOrd a => Expr a -> Expr a -> Expr a
133−greatestExpr ma mb = case Schema.nullable @a of
132+greatestExpr ma mb = case nullable @a of
134− Null -> nullable mb (\a -> nullable ma (greatest_ a) mb) ma
133+ Null -> nullableExpr mb (\a -> nullableExpr ma (greatest_ a) mb) ma
135 NotNull -> greatest_ ma mb
134 NotNull -> greatest_ ma mb
136 where
135 where
137 greatest_ a b =
136 greatest_ a b =
src/Rel8/Expr/Sequence.hsnew file+22
@@ -0,0 +1,22 @@
1+module Rel8.Expr.Sequence
2+ ( nextval
3+ )
4+where
5+
6+-- base
7+import Data.Int ( Int64 )
8+import Prelude
9+
10+-- rel8
11+import Rel8.Expr ( Expr )
12+import Rel8.Expr.Function ( function )
13+import Rel8.Expr.Serialize ( litExpr )
14+import Rel8.Expr.Text ( quoteIdent )
15+
16+-- text
17+import Data.Text ( pack )
18+
19+
20+-- | See https://www.postgresql.org/docs/current/functions-sequence.html
21+nextval :: String -> Expr Int64
22+nextval = function "nextval" . quoteIdent . litExpr . pack
src/Rel8/Expr/Text.hs+24−4
@@ -17,6 +17,9 @@ module Rel8.Expr.Text
17 , pgClientEncoding, quoteIdent, quoteLiteral, quoteNullable, regexpReplace
17 , pgClientEncoding, quoteIdent, quoteLiteral, quoteNullable, regexpReplace
18 , regexpSplitToArray, repeat, replace, reverse, right, rpad, rtrim
18 , regexpSplitToArray, repeat, replace, reverse, right, rpad, rtrim
19 , splitPart, strpos, substr, translate
19 , splitPart, strpos, substr, translate
20+
21+ -- * @LIKE@ and @ILIKE@
22+ , like, ilike
20 )
23 )
21where
24where
22
25
@@ -24,7 +27,7 @@ where
24import Data.Bool ( Bool )
27import Data.Bool ( Bool )
25import Data.Int ( Int32 )
28import Data.Int ( Int32 )
26import Data.Maybe ( Maybe( Nothing, Just ) )
29import Data.Maybe ( Maybe( Nothing, Just ) )
27−import Prelude ()
30+import Prelude ( flip )
28
31
29-- bytestring
32-- bytestring
30import Data.ByteString ( ByteString )
33import Data.ByteString ( ByteString )
@@ -32,7 +35,6 @@ import Data.ByteString ( ByteString )
32-- rel8
35-- rel8
33import Rel8.Expr ( Expr )
36import Rel8.Expr ( Expr )
34import Rel8.Expr.Function ( binaryOperator, function, nullaryFunction )
37import Rel8.Expr.Function ( binaryOperator, function, nullaryFunction )
35−import Rel8.Type.Array1D ( Array1D )
36
38
37-- text
39-- text
38import Data.Text (Text)
40import Data.Text (Text)
@@ -50,7 +52,7 @@ infixr 6 ++.
50
52
51
53
52-- | Matches regular expression, case sensitive
54-- | Matches regular expression, case sensitive
53−--
55+--
54-- Corresponds to the @~.@ operator.
56-- Corresponds to the @~.@ operator.
55(~.) :: Expr Text -> Expr Text -> Expr Bool
57(~.) :: Expr Text -> Expr Text -> Expr Bool
56(~.) = binaryOperator "~."
58(~.) = binaryOperator "~."
@@ -218,7 +220,7 @@ regexpReplace a b c Nothing = function "regexp_replace" a b c
218
220
219-- | Corresponds to the @regexp_split_to_array@ function.
221-- | Corresponds to the @regexp_split_to_array@ function.
220regexpSplitToArray :: ()
222regexpSplitToArray :: ()
221− => Expr Text -> Expr Text -> Maybe (Expr Text) -> Expr (Array1D Text)
223+ => Expr Text -> Expr Text -> Maybe (Expr Text) -> Expr [Text]
222regexpSplitToArray a b (Just c) = function "regexp_split_to_array" a b c
224regexpSplitToArray a b (Just c) = function "regexp_split_to_array" a b c
223regexpSplitToArray a b Nothing = function "regexp_split_to_array" a b
225regexpSplitToArray a b Nothing = function "regexp_split_to_array" a b
224
226
@@ -274,3 +276,21 @@ substr a b Nothing = function "substr" a b
274-- | Corresponds to the @translate@ function.
276-- | Corresponds to the @translate@ function.
275translate :: Expr Text -> Expr Text -> Expr Text -> Expr Text
277translate :: Expr Text -> Expr Text -> Expr Text -> Expr Text
276translate = function "translate"
278translate = function "translate"
279+
280+
281+-- | @like x y@ corresponds to the expression @y LIKE x@.
282+--
283+-- Note that the arguments to @like@ are swapped. This is to aid currying, so
284+-- you can write expressions like
285+-- @filter (like "Rel%" . packageName) =<< each haskellPackages@
286+like :: Expr Text -> Expr Text -> Expr Bool
287+like = flip (binaryOperator "LIKE")
288+
289+
290+-- | @ilike x y@ corresponds to the expression @y ILIKE x@.
291+--
292+-- Note that the arguments to @ilike@ are swapped. This is to aid currying, so
293+-- you can write expressions like
294+-- @filter (ilike "Rel%" . packageName) =<< each haskellPackages@
295+ilike :: Expr Text -> Expr Text -> Expr Bool
296+ilike = flip (binaryOperator "ILIKE")
src/Rel8/Expr/Time.hs+2−2
@@ -31,7 +31,7 @@ import Prelude
31-- rel8
31-- rel8
32import Rel8.Expr ( Expr )
32import Rel8.Expr ( Expr )
33import Rel8.Expr.Function ( binaryOperator, nullaryFunction )
33import Rel8.Expr.Function ( binaryOperator, nullaryFunction )
34−import Rel8.Expr.Opaleye ( unsafeCastExpr, unsafeLiteral )
34+import Rel8.Expr.Opaleye ( castExpr, unsafeCastExpr, unsafeLiteral )
35
35
36-- time
36-- time
37import Data.Time.Calendar ( Day )
37import Data.Time.Calendar ( Day )
@@ -164,4 +164,4 @@ years = (`scaleInterval` year)
164
164
165
165
166singleton :: String -> Expr CalendarDiffTime
166singleton :: String -> Expr CalendarDiffTime
167−singleton unit = unsafeLiteral $ "'1 " ++ unit ++ "'"
167+singleton unit = castExpr $ unsafeLiteral $ "'1 " ++ unit ++ "'"
src/Rel8/Expr/Window.hsnew file+121
@@ -0,0 +1,121 @@
1+module Rel8.Expr.Window
2+ ( cumulative
3+ , rowNumber
4+ , rank
5+ , denseRank
6+ , percentRank
7+ , cumeDist
8+ , ntile
9+ , lag
10+ , lead
11+ , firstValue
12+ , lastValue
13+ , nthValue
14+ )
15+where
16+
17+-- base
18+import Data.Int ( Int32, Int64 )
19+import Prelude
20+
21+-- opaleye
22+import qualified Opaleye.Internal.Aggregate as Opaleye
23+import qualified Opaleye.Internal.PackMap as Opaleye
24+import qualified Opaleye.Internal.Window as Opaleye
25+import qualified Opaleye.Window as Opaleye
26+
27+-- profunctors
28+import Data.Profunctor (dimap)
29+
30+-- rel8
31+import Rel8.Aggregate ( Aggregate( Aggregate ) )
32+import Rel8.Expr ( Expr )
33+import Rel8.Expr.Opaleye ( fromColumn, fromPrimExpr, toColumn, toPrimExpr )
34+import Rel8.Schema.Null ( Nullify )
35+import Rel8.Window ( Window( Window ) )
36+
37+
38+cumulative :: (a -> Aggregate b) -> Window a (Expr b)
39+cumulative f =
40+ fromWindowFunction $ Opaleye.aggregatorWindowFunction (fromAggregate f) id
41+
42+
43+-- | [@row_number()@](https://www.postgresql.org/docs/current/functions-window.html)
44+rowNumber :: Window a (Expr Int64)
45+rowNumber = fromWindowFunction $ fromPrimExpr . fromColumn <$> Opaleye.rowNumber
46+
47+
48+-- | [@rank()@](https://www.postgresql.org/docs/current/functions-window.html)
49+rank :: Window a (Expr Int64)
50+rank = fromWindowFunction $ fromPrimExpr . fromColumn <$> Opaleye.rank
51+
52+
53+-- | [@dense_rank()@](https://www.postgresql.org/docs/current/functions-window.html)
54+denseRank :: Window a (Expr Int64)
55+denseRank = fromWindowFunction $ fromPrimExpr . fromColumn <$> Opaleye.denseRank
56+
57+
58+-- | [@percent_rank()@](https://www.postgresql.org/docs/current/functions-window.html)
59+percentRank :: Window a (Expr Double)
60+percentRank = fromWindowFunction $ fromPrimExpr . fromColumn <$> Opaleye.percentRank
61+
62+
63+-- | [@cume_dist()@](https://www.postgresql.org/docs/current/functions-window.html)
64+cumeDist :: Window a (Expr Double)
65+cumeDist = fromWindowFunction $ fromPrimExpr . fromColumn <$> Opaleye.cumeDist
66+
67+
68+-- | [@ntile(num_buckets)@](https://www.postgresql.org/docs/current/functions-window.html)
69+ntile :: Expr Int32 -> Window a (Expr Int32)
70+ntile buckets = fromWindowFunction $ fromPrimExpr . fromColumn <$>
71+ Opaleye.ntile (toColumn (toPrimExpr buckets))
72+
73+
74+-- | [@lag(value, offset, default)@](https://www.postgresql.org/docs/current/functions-window.html)
75+lag :: Expr Int32 -> Expr a -> Window (Expr a) (Expr a)
76+lag offset def =
77+ fromWindowFunction $
78+ dimap (toColumn . toPrimExpr) (fromPrimExpr . fromColumn) $
79+ Opaleye.lag (toColumn (toPrimExpr offset)) (toColumn (toPrimExpr def))
80+
81+
82+-- | [@lead(value, offset, default)@](https://www.postgresql.org/docs/current/functions-window.html)
83+lead :: Expr Int32 -> Expr a -> Window (Expr a) (Expr a)
84+lead offset def =
85+ fromWindowFunction $
86+ dimap (toColumn . toPrimExpr) (fromPrimExpr . fromColumn) $
87+ Opaleye.lead (toColumn (toPrimExpr offset)) (toColumn (toPrimExpr def))
88+
89+
90+-- | [@first_value(value)@](https://www.postgresql.org/docs/current/functions-window.html)
91+firstValue :: Window (Expr a) (Expr a)
92+firstValue =
93+ fromWindowFunction $
94+ dimap (toColumn . toPrimExpr) (fromPrimExpr . fromColumn)
95+ Opaleye.firstValue
96+
97+
98+-- | [@last_value(value)@](https://www.postgresql.org/docs/current/functions-window.html)
99+lastValue :: Window (Expr a) (Expr a)
100+lastValue =
101+ fromWindowFunction $
102+ dimap (toColumn . toPrimExpr) (fromPrimExpr . fromColumn)
103+ Opaleye.lastValue
104+
105+
106+-- | [@nth_value(value, n)@](https://www.postgresql.org/docs/current/functions-window.html)
107+nthValue :: Expr Int32 -> Window (Expr a) (Expr (Nullify a))
108+nthValue n =
109+ fromWindowFunction $
110+ dimap (toColumn . toPrimExpr) (fromPrimExpr . fromColumn) $
111+ Opaleye.nthValue (toColumn (toPrimExpr n))
112+
113+
114+fromAggregate :: (a -> Aggregate b) -> Opaleye.Aggregator a (Expr b)
115+fromAggregate f = Opaleye.Aggregator $ Opaleye.PackMap $ \w a -> case f a of
116+ Aggregate (Opaleye.Aggregator (Opaleye.PackMap x)) -> x w ()
117+
118+
119+fromWindowFunction :: Opaleye.WindowFunction a b -> Window a b
120+fromWindowFunction (Opaleye.WindowFunction (Opaleye.PackMap w)) =
121+ Window $ Opaleye.Windows $ Opaleye.PackMap $ \f -> w $ \o -> f (o, mempty)
src/Rel8/FCF.hs+9−1
@@ -3,7 +3,11 @@
3{-# language StandaloneKindSignatures #-}
3{-# language StandaloneKindSignatures #-}
4{-# language TypeFamilies #-}
4{-# language TypeFamilies #-}
5
5
6−module Rel8.FCF ( Exp, Eval ) where
6+module Rel8.FCF
7+ ( Exp, Eval
8+ , Id
9+ )
10+where
7
11
8-- base
12-- base
9import Data.Kind ( Type )
13import Data.Kind ( Type )
@@ -16,3 +20,7 @@ type Exp e = e -> Type
16
20
17type Eval :: Exp e -> e
21type Eval :: Exp e -> e
18type family Eval a
22type family Eval a
23+
24+
25+data Id :: a -> Exp a
26+type instance Eval (Id a) = a
src/Rel8/Generic/Construction.hsnew file+352
@@ -0,0 +1,352 @@
1+{-# language AllowAmbiguousTypes #-}
2+{-# language ConstraintKinds #-}
3+{-# language DataKinds #-}
4+{-# language FlexibleContexts #-}
5+{-# language NamedFieldPuns #-}
6+{-# language ScopedTypeVariables #-}
7+{-# language StandaloneKindSignatures #-}
8+{-# language TypeApplications #-}
9+{-# language TypeFamilies #-}
10+{-# language UndecidableInstances #-}
11+{-# language ViewPatterns #-}
12+
13+module Rel8.Generic.Construction
14+ ( GGBuildable
15+ , GGBuild, ggbuild
16+ , GGConstructable
17+ , GGConstruct, ggconstruct
18+ , GGDeconstruct, ggdeconstruct
19+ , GGName, ggname
20+ , GGAggregate, ggaggregate
21+ )
22+where
23+
24+-- base
25+import Data.Bifunctor ( first )
26+import Data.Kind ( Constraint, Type )
27+import Data.List.NonEmpty ( NonEmpty( (:|) ) )
28+import GHC.TypeLits ( Symbol )
29+import Prelude
30+
31+-- rel8
32+import Rel8.Aggregate ( Aggregate( Aggregate ) )
33+import Rel8.Expr ( Expr )
34+import Rel8.Expr.Aggregate ( groupByExpr )
35+import Rel8.Expr.Eq ( (==.) )
36+import Rel8.Expr.Null ( nullify, snull, unsafeUnnullify )
37+import Rel8.Expr.Serialize ( litExpr )
38+import Rel8.FCF ( Eval, Exp, Id )
39+import Rel8.Generic.Construction.ADT
40+ ( GConstructorADT, GMakeableADT, gmakeADT
41+ , GConstructableADT
42+ , GBuildADT, gbuildADT, gunbuildADT
43+ , GConstructADT, gconstructADT, gdeconstructADT
44+ , RepresentableConstructors, GConstructors, gcindex, gctabulate
45+ , RepresentableFields, gfindex, gftabulate
46+ )
47+import Rel8.Generic.Construction.Record
48+ ( GConstructor
49+ , GConstructable, GConstruct, gconstruct, gdeconstruct
50+ , Representable, gindex, gtabulate
51+ )
52+import Rel8.Generic.Table ( GGColumns )
53+import Rel8.Kind.Algebra
54+ ( SAlgebra( SProduct, SSum )
55+ , KnownAlgebra, algebraSing
56+ )
57+import qualified Rel8.Kind.Algebra as K
58+import Rel8.Schema.Context.Nullify ( sguard, snullify )
59+import Rel8.Schema.HTable ( HTable )
60+import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
61+import qualified Rel8.Schema.Kind as K
62+import Rel8.Schema.Name ( Name( Name ) )
63+import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
64+import Rel8.Schema.Spec ( Spec( Spec, nullity, info ) )
65+import Rel8.Table
66+ ( TTable, TColumns
67+ , Table, fromColumns, toColumns
68+ )
69+import Rel8.Table.Bool ( case_ )
70+import Rel8.Type.Tag ( Tag )
71+
72+
73+type GGBuildable :: K.Algebra -> Symbol -> (K.Context -> Exp (Type -> Type)) -> Constraint
74+type GGBuildable algebra name rep =
75+ ( KnownAlgebra algebra
76+ , Eval (GGColumns algebra TColumns (Eval (rep Aggregate))) ~ Eval (GGColumns algebra TColumns (Eval (rep Expr)))
77+ , Eval (GGColumns algebra TColumns (Eval (rep Expr))) ~ Eval (GGColumns algebra TColumns (Eval (rep Expr)))
78+ , Eval (GGColumns algebra TColumns (Eval (rep Name))) ~ Eval (GGColumns algebra TColumns (Eval (rep Expr)))
79+ , HTable (Eval (GGColumns algebra TColumns (Eval (rep Expr))))
80+ , GGBuildable' algebra name rep
81+ )
82+
83+
84+type GGBuildable' :: K.Algebra -> Symbol -> (K.Context -> Exp (Type -> Type)) -> Constraint
85+type family GGBuildable' algebra name rep where
86+ GGBuildable' 'K.Product name rep =
87+ ( name ~ GConstructor (Eval (rep Expr))
88+ , Representable Id (Eval (rep Expr))
89+ , GConstructable (TTable Expr) TColumns Id Expr (Eval (rep Expr))
90+ )
91+ GGBuildable' 'K.Sum name rep =
92+ ( Representable Id (GConstructorADT name (Eval (rep Expr)))
93+ , GMakeableADT (TTable Expr) TColumns Id Expr name (Eval (rep Expr))
94+ )
95+
96+
97+type GGBuild :: K.Algebra -> Symbol -> (K.Context -> Exp (Type -> Type)) -> Type -> Type
98+type family GGBuild algebra name rep r where
99+ GGBuild 'K.Product _name rep r =
100+ GConstruct Id (Eval (rep Expr)) r
101+ GGBuild 'K.Sum name rep r =
102+ GConstruct Id (GConstructorADT name (Eval (rep Expr))) r
103+
104+
105+ggbuild :: forall algebra name rep a. GGBuildable algebra name rep
106+ => (Eval (GGColumns algebra TColumns (Eval (rep Expr))) Expr -> a)
107+ -> GGBuild algebra name rep a
108+ggbuild gfromColumns = case algebraSing @algebra of
109+ SProduct ->
110+ gtabulate @Id @(Eval (rep Expr)) @a $
111+ gfromColumns .
112+ gconstruct
113+ @(TTable Expr)
114+ @TColumns
115+ @Id
116+ @Expr
117+ @(Eval (rep Expr))
118+ (const toColumns)
119+ SSum ->
120+ gtabulate @Id @(GConstructorADT name (Eval (rep Expr))) @a $
121+ gfromColumns .
122+ gmakeADT
123+ @(TTable Expr)
124+ @TColumns
125+ @Id
126+ @Expr
127+ @name
128+ @(Eval (rep Expr))
129+ (const toColumns)
130+ (\Spec {info} -> snull info)
131+ (\Spec {nullity} -> case nullity of
132+ Null -> id
133+ NotNull -> nullify)
134+ (HIdentity . litExpr)
135+
136+
137+type GGConstructable :: K.Algebra -> (K.Context -> Exp (Type -> Type)) -> Constraint
138+type GGConstructable algebra rep =
139+ ( KnownAlgebra algebra
140+ , Eval (GGColumns algebra TColumns (Eval (rep Aggregate))) ~ Eval (GGColumns algebra TColumns (Eval (rep Expr)))
141+ , Eval (GGColumns algebra TColumns (Eval (rep Expr))) ~ Eval (GGColumns algebra TColumns (Eval (rep Expr)))
142+ , Eval (GGColumns algebra TColumns (Eval (rep Name))) ~ Eval (GGColumns algebra TColumns (Eval (rep Expr)))
143+ , HTable (Eval (GGColumns algebra TColumns (Eval (rep Expr))))
144+ , GGConstructable' algebra rep
145+ )
146+
147+
148+type GGConstructable' :: K.Algebra -> (K.Context -> Exp (Type -> Type)) -> Constraint
149+type family GGConstructable' algebra rep where
150+ GGConstructable' 'K.Product rep =
151+ ( Representable Id (Eval (rep Aggregate))
152+ , Representable Id (Eval (rep Expr))
153+ , Representable Id (Eval (rep Name))
154+ , GConstructable (TTable Aggregate) TColumns Id Aggregate (Eval (rep Aggregate))
155+ , GConstructable (TTable Expr) TColumns Id Expr (Eval (rep Expr))
156+ , GConstructable (TTable Name) TColumns Id Name (Eval (rep Name))
157+ )
158+ GGConstructable' 'K.Sum rep =
159+ ( RepresentableConstructors Id (Eval (rep Expr))
160+ , RepresentableFields Id (Eval (rep Aggregate))
161+ , RepresentableFields Id (Eval (rep Expr))
162+ , RepresentableFields Id (Eval (rep Name))
163+ , Functor (GConstructors Id (Eval (rep Expr)))
164+ , GConstructableADT (TTable Aggregate) TColumns Id Aggregate (Eval (rep Aggregate))
165+ , GConstructableADT (TTable Expr) TColumns Id Expr (Eval (rep Expr))
166+ , GConstructableADT (TTable Name) TColumns Id Name (Eval (rep Name))
167+ )
168+
169+
170+type GGConstruct :: K.Algebra -> (K.Context -> Exp (Type -> Type)) -> Type -> Type
171+type family GGConstruct algebra rep r where
172+ GGConstruct 'K.Product rep r = GConstruct Id (Eval (rep Expr)) r -> r
173+ GGConstruct 'K.Sum rep r = GConstructADT Id (Eval (rep Expr)) r r
174+
175+
176+ggconstruct :: forall algebra rep a. GGConstructable algebra rep
177+ => (Eval (GGColumns algebra TColumns (Eval (rep Expr))) Expr -> a)
178+ -> GGConstruct algebra rep a -> a
179+ggconstruct gfromColumns f = case algebraSing @algebra of
180+ SProduct ->
181+ f $
182+ gtabulate @Id @(Eval (rep Expr)) @a $
183+ gfromColumns .
184+ gconstruct
185+ @(TTable Expr)
186+ @TColumns
187+ @Id
188+ @Expr
189+ @(Eval (rep Expr))
190+ (const toColumns)
191+ SSum ->
192+ gcindex @Id @(Eval (rep Expr)) @a f $
193+ fmap gfromColumns $
194+ gconstructADT
195+ @(TTable Expr)
196+ @TColumns
197+ @Id
198+ @Expr
199+ @(Eval (rep Expr))
200+ (const toColumns)
201+ (\Spec {info} -> snull info)
202+ (\Spec {nullity} -> case nullity of
203+ Null -> id
204+ NotNull -> nullify)
205+ (HIdentity . litExpr)
206+
207+
208+type GGDeconstruct :: K.Algebra -> (K.Context -> Exp (Type -> Type)) -> Type -> Type -> Type
209+type family GGDeconstruct algebra rep a r where
210+ GGDeconstruct 'K.Product rep a r =
211+ GConstruct Id (Eval (rep Expr)) r -> a -> r
212+ GGDeconstruct 'K.Sum rep a r =
213+ GConstructADT Id (Eval (rep Expr)) r (a -> r)
214+
215+
216+ggdeconstruct :: forall algebra rep a r. (GGConstructable algebra rep, Table Expr r)
217+ => (a -> Eval (GGColumns algebra TColumns (Eval (rep Expr))) Expr)
218+ -> GGDeconstruct algebra rep a r
219+ggdeconstruct gtoColumns = case algebraSing @algebra of
220+ SProduct -> \build ->
221+ gindex @Id @(Eval (rep Expr)) @r build .
222+ gdeconstruct
223+ @(TTable Expr)
224+ @TColumns
225+ @Id
226+ @Expr
227+ @(Eval (rep Expr))
228+ (const fromColumns) .
229+ gtoColumns
230+ SSum ->
231+ gctabulate @Id @(Eval (rep Expr)) @r @(a -> r) $ \constructors as ->
232+ let
233+ (HIdentity tag, cases) =
234+ gdeconstructADT
235+ @(TTable Expr)
236+ @TColumns
237+ @Id
238+ @Expr
239+ @(Eval (rep Expr))
240+ (const fromColumns)
241+ (\Spec {nullity} -> case nullity of
242+ Null -> id
243+ NotNull -> unsafeUnnullify)
244+ constructors $
245+ gtoColumns as
246+ in
247+ case cases of
248+ ((_, r) :| (map (first ((tag ==.) . litExpr)) -> cases')) ->
249+ case_ cases' r
250+
251+
252+type GGName :: K.Algebra -> (K.Context -> Exp (Type -> Type)) -> Type -> Type
253+type family GGName algebra rep a where
254+ GGName 'K.Product rep a = GConstruct Id (Eval (rep Name)) a
255+ GGName 'K.Sum rep a = Name Tag -> GBuildADT Id (Eval (rep Name)) a
256+
257+
258+ggname :: forall algebra rep a. GGConstructable algebra rep
259+ => (Eval (GGColumns algebra TColumns (Eval (rep Expr))) Name -> a)
260+ -> GGName algebra rep a
261+ggname gfromColumns = case algebraSing @algebra of
262+ SProduct ->
263+ gtabulate @Id @(Eval (rep Name)) @a $
264+ gfromColumns .
265+ gconstruct
266+ @(TTable Name)
267+ @TColumns
268+ @Id
269+ @Name
270+ @(Eval (rep Name))
271+ (const toColumns)
272+ SSum -> \tag ->
273+ gftabulate @Id @(Eval (rep Name)) @a $
274+ gfromColumns .
275+ gbuildADT
276+ @(TTable Name)
277+ @TColumns
278+ @Id
279+ @Name
280+ @(Eval (rep Name))
281+ (const toColumns)
282+ (\_ _ (Name a) -> Name a)
283+ (HIdentity tag)
284+
285+
286+type GGAggregate :: K.Algebra -> (K.Context -> Exp (Type -> Type)) -> Type -> Type
287+type family GGAggregate algebra rep r where
288+ GGAggregate 'K.Product rep r =
289+ GConstruct Id (Eval (rep Aggregate)) r ->
290+ GConstruct Id (Eval (rep Expr)) r
291+ GGAggregate 'K.Sum rep r =
292+ GBuildADT Id (Eval (rep Aggregate)) r ->
293+ GBuildADT Id (Eval (rep Expr)) r
294+
295+
296+ggaggregate :: forall algebra rep exprs agg. GGConstructable algebra rep
297+ => (Eval (GGColumns algebra TColumns (Eval (rep Expr))) Aggregate -> agg)
298+ -> (exprs -> Eval (GGColumns algebra TColumns (Eval (rep Expr))) Expr)
299+ -> GGAggregate algebra rep agg -> exprs -> agg
300+ggaggregate gfromColumns gtoColumns agg es = case algebraSing @algebra of
301+ SProduct -> flip f exprs $
302+ gfromColumns .
303+ gconstruct
304+ @(TTable Aggregate)
305+ @TColumns
306+ @Id
307+ @Aggregate
308+ @(Eval (rep Aggregate))
309+ (const toColumns)
310+ where
311+ f =
312+ gindex @Id @(Eval (rep Expr)) @agg .
313+ agg .
314+ gtabulate @Id @(Eval (rep Aggregate)) @agg
315+ exprs =
316+ gdeconstruct
317+ @(TTable Expr)
318+ @TColumns
319+ @Id
320+ @Expr
321+ @(Eval (rep Expr))
322+ (const fromColumns) $
323+ gtoColumns es
324+ SSum -> flip f exprs $
325+ gfromColumns .
326+ gbuildADT
327+ @(TTable Aggregate)
328+ @TColumns
329+ @Id
330+ @Aggregate
331+ @(Eval (rep Aggregate))
332+ (const toColumns)
333+ (\tag' Spec {nullity} (Aggregate a) ->
334+ Aggregate $ sguard (tag ==. litExpr tag') . snullify nullity <$> a)
335+ (HIdentity (groupByExpr tag))
336+ where
337+ f =
338+ gfindex @Id @(Eval (rep Expr)) @agg .
339+ agg .
340+ gftabulate @Id @(Eval (rep Aggregate)) @agg
341+ (HIdentity tag, exprs) =
342+ gunbuildADT
343+ @(TTable Expr)
344+ @TColumns
345+ @Id
346+ @Expr
347+ @(Eval (rep Expr))
348+ (const fromColumns)
349+ (\Spec {nullity} -> case nullity of
350+ Null -> id
351+ NotNull -> unsafeUnnullify) $
352+ gtoColumns es
src/Rel8/Generic/Construction/ADT.hsnew file+478
@@ -0,0 +1,478 @@
1+{-# language AllowAmbiguousTypes #-}
2+{-# language BlockArguments #-}
3+{-# language DataKinds #-}
4+{-# language FlexibleContexts #-}
5+{-# language FlexibleInstances #-}
6+{-# language MultiParamTypeClasses #-}
7+{-# language RankNTypes #-}
8+{-# language ScopedTypeVariables #-}
9+{-# language StandaloneKindSignatures #-}
10+{-# language TupleSections #-}
11+{-# language TypeApplications #-}
12+{-# language TypeFamilies #-}
13+{-# language TypeOperators #-}
14+{-# language UndecidableInstances #-}
15+
16+module Rel8.Generic.Construction.ADT
17+ ( GConstructableADT
18+ , GBuildADT, gbuildADT, gunbuildADT
19+ , GConstructADT, gconstructADT, gdeconstructADT
20+ , GFields, RepresentableFields, gftabulate, gfindex
21+ , GConstructors, RepresentableConstructors, gctabulate, gcindex
22+ , GConstructorADT, GMakeableADT, gmakeADT
23+ )
24+where
25+
26+-- base
27+import Data.Bifunctor ( first )
28+import Data.Functor.Identity ( runIdentity )
29+import Data.Kind ( Constraint, Type )
30+import Data.List.NonEmpty ( NonEmpty )
31+import Data.Proxy ( Proxy( Proxy ) )
32+import GHC.Generics
33+ ( (:+:), (:*:)( (:*:) ), M1, U1
34+ , C, D
35+ , Meta( MetaData, MetaCons )
36+ )
37+import GHC.TypeLits
38+ ( ErrorMessage( (:<>:), Text ), TypeError
39+ , Symbol, KnownSymbol, symbolVal
40+ )
41+import Prelude hiding ( null )
42+
43+-- rel8
44+import Rel8.FCF ( Exp )
45+import Rel8.Generic.Construction.Record
46+ ( GConstruct, GConstructable, gconstruct, gdeconstruct
47+ , GFields, Representable, gtabulate, gindex
48+ , FromColumns, ToColumns
49+ )
50+import Rel8.Generic.Table.ADT ( GColumnsADT, GColumnsADT' )
51+import Rel8.Generic.Table.Record ( GColumns )
52+import Rel8.Schema.HTable ( HTable )
53+import Rel8.Schema.HTable.Identity ( HIdentity )
54+import Rel8.Schema.HTable.Label ( HLabel, hlabel, hunlabel )
55+import Rel8.Schema.HTable.Nullify ( HNullify, hnulls, hnullify, hunnullify )
56+import Rel8.Schema.HTable.Product ( HProduct( HProduct ) )
57+import Rel8.Schema.Null ( Nullify )
58+import Rel8.Schema.Spec ( Spec )
59+import qualified Rel8.Schema.Kind as K
60+import Rel8.Type.Tag ( Tag( Tag ) )
61+
62+-- text
63+import Data.Text ( pack )
64+
65+
66+type Null :: K.Context -> Type
67+type Null context = forall a. Spec a -> context (Nullify a)
68+
69+
70+type Nullifier :: K.Context -> Type
71+type Nullifier context = forall a. Spec a -> context a -> context (Nullify a)
72+
73+
74+type Unnullifier :: K.Context -> Type
75+type Unnullifier context = forall a. Spec a -> context (Nullify a) -> context a
76+
77+
78+type NoConstructor :: Symbol -> Symbol -> ErrorMessage
79+type NoConstructor datatype constructor =
80+ ( 'Text "The type `" ':<>:
81+ 'Text datatype ':<>:
82+ 'Text "` has no constructor `" ':<>:
83+ 'Text constructor ':<>:
84+ 'Text "`."
85+ )
86+
87+
88+type GConstructorADT :: Symbol -> (Type -> Type) -> Type -> Type
89+type family GConstructorADT name rep where
90+ GConstructorADT name (M1 D ('MetaData datatype _ _ _) rep) =
91+ GConstructorADT' name rep (TypeError (NoConstructor datatype name))
92+
93+
94+type GConstructorADT' :: Symbol -> (Type -> Type) -> (Type -> Type) -> Type -> Type
95+type family GConstructorADT' name rep fallback where
96+ GConstructorADT' name (M1 D _ rep) fallback =
97+ GConstructorADT' name rep fallback
98+ GConstructorADT' name (a :+: b) fallback =
99+ GConstructorADT' name a (GConstructorADT' name b fallback)
100+ GConstructorADT' name (M1 C ('MetaCons name _ _) rep) _ = rep
101+ GConstructorADT' _ _ fallback = fallback
102+
103+
104+type GConstructADT
105+ :: (Type -> Exp Type)
106+ -> (Type -> Type) -> Type -> Type -> Type
107+type family GConstructADT f rep r x where
108+ GConstructADT f (M1 D _ rep) r x = GConstructADT f rep r x
109+ GConstructADT f (a :+: b) r x = GConstructADT f a r (GConstructADT f b r x)
110+ GConstructADT f (M1 C _ rep) r x = GConstruct f rep r -> x
111+
112+
113+type GConstructors :: (Type -> Exp Type) -> (Type -> Type) -> Type -> Type
114+type family GConstructors f rep where
115+ GConstructors f (M1 D _ rep) = GConstructors f rep
116+ GConstructors f (a :+: b) = GConstructors f a :*: GConstructors f b
117+ GConstructors f (M1 C _ rep) = (->) (GFields f rep)
118+
119+
120+type RepresentableConstructors :: (Type -> Exp Type) -> (Type -> Type) -> Constraint
121+class RepresentableConstructors f rep where
122+ gctabulate :: (GConstructors f rep r -> a) -> GConstructADT f rep r a
123+ gcindex :: GConstructADT f rep r a -> GConstructors f rep r -> a
124+
125+
126+instance RepresentableConstructors f rep => RepresentableConstructors f (M1 D meta rep) where
127+ gctabulate = gctabulate @f @rep
128+ gcindex = gcindex @f @rep
129+
130+
131+instance (RepresentableConstructors f a, RepresentableConstructors f b) =>
132+ RepresentableConstructors f (a :+: b)
133+ where
134+ gctabulate f =
135+ gctabulate @f @a \a -> gctabulate @f @b \b -> f (a :*: b)
136+ gcindex f (a :*: b) = gcindex @f @b (gcindex @f @a f a) b
137+
138+
139+instance Representable f rep => RepresentableConstructors f (M1 C meta rep) where
140+ gctabulate f = f . gindex @f @rep
141+ gcindex f = f . gtabulate @f @rep
142+
143+
144+type GBuildADT :: (Type -> Exp Type) -> (Type -> Type) -> Type -> Type
145+type family GBuildADT f rep r where
146+ GBuildADT f (M1 D _ rep) r = GBuildADT f rep r
147+ GBuildADT f (a :+: b) r = GBuildADT f a (GBuildADT f b r)
148+ GBuildADT f (M1 C _ rep) r = GConstruct f rep r
149+
150+
151+type GFieldsADT :: (Type -> Exp Type) -> (Type -> Type) -> Type
152+type family GFieldsADT f rep where
153+ GFieldsADT f (M1 D _ rep) = GFieldsADT f rep
154+ GFieldsADT f (a :+: b) = (GFieldsADT f a, GFieldsADT f b)
155+ GFieldsADT f (M1 C _ rep) = GFields f rep
156+
157+
158+type RepresentableFields :: (Type -> Exp Type) -> (Type -> Type) -> Constraint
159+class RepresentableFields f rep where
160+ gftabulate :: (GFieldsADT f rep -> a) -> GBuildADT f rep a
161+ gfindex :: GBuildADT f rep a -> GFieldsADT f rep -> a
162+
163+
164+instance RepresentableFields f rep => RepresentableFields f (M1 D meta rep) where
165+ gftabulate = gftabulate @f @rep
166+ gfindex = gfindex @f @rep
167+
168+
169+instance (RepresentableFields f a, RepresentableFields f b) => RepresentableFields f (a :+: b) where
170+ gftabulate f =
171+ gftabulate @f @a \a -> gftabulate @f @b \b -> f (a, b)
172+ gfindex f (a, b) = gfindex @f @b (gfindex @f @a f a) b
173+
174+
175+instance Representable f rep => RepresentableFields f (M1 C meta rep) where
176+ gftabulate = gtabulate @f @rep
177+ gfindex = gindex @f @rep
178+
179+
180+type GConstructableADT
181+ :: (Type -> Exp Constraint)
182+ -> (Type -> Exp K.HTable)
183+ -> (Type -> Exp Type)
184+ -> K.Context -> (Type -> Type) -> Constraint
185+class GConstructableADT _Table _Columns f context rep where
186+ gbuildADT :: ()
187+ => ToColumns _Table _Columns f context
188+ -> (Tag -> Nullifier context)
189+ -> HIdentity Tag context
190+ -> GFieldsADT f rep
191+ -> GColumnsADT _Columns rep context
192+
193+ gunbuildADT :: ()
194+ => FromColumns _Table _Columns f context
195+ -> Unnullifier context
196+ -> GColumnsADT _Columns rep context
197+ -> (HIdentity Tag context, GFieldsADT f rep)
198+
199+ gconstructADT :: ()
200+ => ToColumns _Table _Columns f context
201+ -> Null context
202+ -> Nullifier context
203+ -> (Tag -> HIdentity Tag context)
204+ -> GConstructors f rep (GColumnsADT _Columns rep context)
205+
206+ gdeconstructADT :: ()
207+ => FromColumns _Table _Columns f context
208+ -> Unnullifier context
209+ -> GConstructors f rep r
210+ -> GColumnsADT _Columns rep context
211+ -> (HIdentity Tag context, NonEmpty (Tag, r))
212+
213+
214+instance
215+ ( htable ~ HLabel "tag" (HIdentity Tag)
216+ , GConstructableADT' _Table _Columns f context htable rep
217+ )
218+ => GConstructableADT _Table _Columns f context (M1 D meta rep)
219+ where
220+ gbuildADT toColumns nullifier =
221+ gbuildADT' @_Table @_Columns @f @context @htable @rep toColumns nullifier .
222+ hlabel
223+
224+ gunbuildADT fromColumns unnullifier =
225+ first hunlabel .
226+ gunbuildADT' @_Table @_Columns @f @context @htable @rep fromColumns unnullifier
227+
228+ gconstructADT toColumns null nullifier mk =
229+ gconstructADT' @_Table @_Columns @f @context @htable @rep toColumns null nullifier
230+ (hlabel . mk)
231+
232+ gdeconstructADT fromColumns unnullifier cases =
233+ first hunlabel .
234+ gdeconstructADT' @_Table @_Columns @f @context @htable @rep fromColumns unnullifier cases
235+
236+
237+type GConstructableADT'
238+ :: (Type -> Exp Constraint)
239+ -> (Type -> Exp K.HTable)
240+ -> (Type -> Exp Type)
241+ -> K.Context -> K.HTable -> (Type -> Type) -> Constraint
242+class GConstructableADT' _Table _Columns f context htable rep where
243+ gbuildADT' :: ()
244+ => ToColumns _Table _Columns f context
245+ -> (Tag -> Nullifier context)
246+ -> htable context
247+ -> GFieldsADT f rep
248+ -> GColumnsADT' _Columns htable rep context
249+
250+ gunbuildADT' :: ()
251+ => FromColumns _Table _Columns f context
252+ -> Unnullifier context
253+ -> GColumnsADT' _Columns htable rep context
254+ -> (htable context, GFieldsADT f rep)
255+
256+ gconstructADT' :: ()
257+ => ToColumns _Table _Columns f context
258+ -> Null context
259+ -> Nullifier context
260+ -> (Tag -> htable context)
261+ -> GConstructors f rep (GColumnsADT' _Columns htable rep context)
262+
263+ gdeconstructADT' :: ()
264+ => FromColumns _Table _Columns f context
265+ -> Unnullifier context
266+ -> GConstructors f rep r
267+ -> GColumnsADT' _Columns htable rep context
268+ -> (htable context, NonEmpty (Tag, r))
269+
270+ gfill :: ()
271+ => Null context
272+ -> htable context
273+ -> GColumnsADT' _Columns htable rep context
274+
275+
276+instance
277+ ( htable' ~ GColumnsADT' _Columns htable a
278+ , Functor (GConstructors f a)
279+ , GConstructableADT' _Table _Columns f context htable a
280+ , GConstructableADT' _Table _Columns f context htable' b
281+ )
282+ => GConstructableADT' _Table _Columns f context htable (a :+: b)
283+ where
284+ gbuildADT' toColumns nullifier htable (a, b) =
285+ gbuildADT' @_Table @_Columns @f @context @htable' @b toColumns nullifier
286+ (gbuildADT' @_Table @_Columns @f @context @htable @a toColumns nullifier htable a)
287+ b
288+
289+ gunbuildADT' fromColumns unnullifier columns =
290+ case gunbuildADT' @_Table @_Columns @f @context @htable' @b fromColumns unnullifier columns of
291+ (htable', b) ->
292+ case gunbuildADT' @_Table @_Columns @f @context @htable @a fromColumns unnullifier htable' of
293+ (htable, a) -> (htable, (a, b))
294+
295+ gconstructADT' toColumns null nullifier mk =
296+ fmap (gfill @_Table @_Columns @f @context @htable' @b null) (gconstructADT' @_Table @_Columns @f @context @htable @a toColumns null nullifier mk) :*:
297+ gconstructADT' @_Table @_Columns @f @context @htable' @b toColumns null nullifier (gfill @_Table @_Columns @f @context @htable @a null . mk)
298+
299+ gdeconstructADT' fromColumns unnullifier (a :*: b) columns =
300+ case gdeconstructADT' @_Table @_Columns @f @context @htable' @b fromColumns unnullifier b columns of
301+ (htable', cases) ->
302+ case gdeconstructADT' @_Table @_Columns @f @context @htable @a fromColumns unnullifier a htable' of
303+ (htable, cases') -> (htable, cases' <> cases)
304+
305+ gfill null =
306+ gfill @_Table @_Columns @f @context @htable' @b null .
307+ gfill @_Table @_Columns @f @context @htable @a null
308+
309+
310+instance (meta ~ 'MetaCons label _fixity _isRecord, KnownSymbol label) =>
311+ GConstructableADT' _Table _Columns f context htable (M1 C meta U1)
312+ where
313+ gbuildADT' _ _ = const
314+ gunbuildADT' _ _ = (, ())
315+ gconstructADT' _ _ _ f _ = f tag
316+ where
317+ tag = Tag $ pack $ symbolVal (Proxy @label)
318+ gdeconstructADT' _ _ r htable = (htable, pure (tag, r ()))
319+ where
320+ tag = Tag $ pack $ symbolVal (Proxy @label)
321+ gfill _ = id
322+
323+
324+instance {-# OVERLAPPABLE #-}
325+ ( HTable (GColumns _Columns rep)
326+ , KnownSymbol label
327+ , meta ~ 'MetaCons label _fixity _isRecord
328+ , GConstructable _Table _Columns f context rep
329+ , GColumnsADT' _Columns htable (M1 C meta rep) ~
330+ HProduct htable (HLabel label (HNullify (GColumns _Columns rep)))
331+ )
332+ => GConstructableADT' _Table _Columns f context htable (M1 C meta rep)
333+ where
334+ gbuildADT' toColumns nullifier htable =
335+ HProduct htable .
336+ hlabel .
337+ hnullify (nullifier tag) .
338+ gconstruct @_Table @_Columns @f @context @rep toColumns
339+ where
340+ tag = Tag $ pack $ symbolVal (Proxy @label)
341+
342+ gunbuildADT' fromColumns unnullifier (HProduct htable a) =
343+ ( htable
344+ , gdeconstruct @_Table @_Columns @f @context @rep fromColumns $
345+ runIdentity $
346+ hunnullify (\spec -> pure . unnullifier spec) $
347+ hunlabel
348+ a
349+ )
350+
351+ gconstructADT' toColumns _ nullifier mk =
352+ HProduct htable .
353+ hlabel .
354+ hnullify nullifier .
355+ gconstruct @_Table @_Columns @f @context @rep toColumns
356+ where
357+ tag = Tag $ pack $ symbolVal (Proxy @label)
358+ htable = mk tag
359+
360+ gdeconstructADT' fromColumns unnullifier r (HProduct htable columns) =
361+ ( htable
362+ , pure (tag, r a)
363+ )
364+ where
365+ a = gdeconstruct @_Table @_Columns @f @context @rep fromColumns $
366+ runIdentity $
367+ hunnullify (\spec -> pure . unnullifier spec) $
368+ hunlabel
369+ columns
370+ tag = Tag $ pack $ symbolVal (Proxy @label)
371+
372+ gfill null htable = HProduct htable (hlabel (hnulls null))
373+
374+
375+type GMakeableADT
376+ :: (Type -> Exp Constraint)
377+ -> (Type -> Exp K.HTable)
378+ -> (Type -> Exp Type)
379+ -> K.Context -> Symbol -> (Type -> Type) -> Constraint
380+class GMakeableADT _Table _Columns f context name rep where
381+ gmakeADT :: ()
382+ => ToColumns _Table _Columns f context
383+ -> Null context
384+ -> Nullifier context
385+ -> (Tag -> HIdentity Tag context)
386+ -> GFields f (GConstructorADT name rep)
387+ -> GColumnsADT _Columns rep context
388+
389+
390+instance
391+ ( htable ~ HLabel "tag" (HIdentity Tag)
392+ , meta ~ 'MetaData datatype _module _package _newtype
393+ , fallback ~ TypeError (NoConstructor datatype name)
394+ , fields ~ GFields f (GConstructorADT' name rep fallback)
395+ , GMakeableADT' _Table _Columns f context htable name rep fields
396+ , KnownSymbol name
397+ )
398+ => GMakeableADT _Table _Columns f context name (M1 D meta rep)
399+ where
400+ gmakeADT toColumns null nullifier wrap =
401+ gmakeADT'
402+ @_Table @_Columns @f @context @htable @name @rep @fields
403+ toColumns null nullifier htable
404+ where
405+ tag = Tag $ pack $ symbolVal (Proxy @name)
406+ htable = hlabel (wrap tag)
407+
408+
409+type GMakeableADT'
410+ :: (Type -> Exp Constraint)
411+ -> (Type -> Exp K.HTable)
412+ -> (Type -> Exp Type)
413+ -> K.Context -> K.HTable -> Symbol -> (Type -> Type) -> Type -> Constraint
414+class GMakeableADT' _Table _Columns f context htable name rep fields where
415+ gmakeADT' :: ()
416+ => ToColumns _Table _Columns f context
417+ -> Null context
418+ -> Nullifier context
419+ -> htable context
420+ -> fields
421+ -> GColumnsADT' _Columns htable rep context
422+
423+
424+instance
425+ ( htable' ~ GColumnsADT' _Columns htable a
426+ , GMakeableADT' _Table _Columns f context htable name a fields
427+ , GMakeableADT' _Table _Columns f context htable' name b fields
428+ )
429+ => GMakeableADT' _Table _Columns f context htable name (a :+: b) fields
430+ where
431+ gmakeADT' toColumns null nullifier htable x =
432+ gmakeADT' @_Table @_Columns @f @context @htable' @name @b @fields
433+ toColumns null nullifier
434+ (gmakeADT'
435+ @_Table @_Columns @f @context @htable @name @a @fields toColumns
436+ null nullifier htable x)
437+ x
438+
439+
440+instance {-# OVERLAPPING #-}
441+ GMakeableADT' _Table _Columns f context htable name (M1 C ('MetaCons name _fixity _isRecord) U1) fields
442+ where
443+ gmakeADT' _ _ _ = const
444+
445+
446+instance {-# OVERLAPS #-}
447+ GMakeableADT' _Table _Columns f context htable name (M1 C ('MetaCons label _fixity _isRecord) U1) fields
448+ where
449+ gmakeADT' _ _ _ = const
450+
451+
452+instance {-# OVERLAPS #-}
453+ ( HTable (GColumns _Columns rep)
454+ , GConstructable _Table _Columns f context rep
455+ , fields ~ GFields f rep
456+ , GColumnsADT' _Columns htable (M1 C ('MetaCons name _fixity _isRecord) rep) ~
457+ HProduct htable (HLabel name (HNullify (GColumns _Columns rep)))
458+ )
459+ => GMakeableADT' _Table _Columns f context htable name (M1 C ('MetaCons name _fixity _isRecord) rep) fields
460+ where
461+ gmakeADT' toColumns _ nullifier htable =
462+ HProduct htable .
463+ hlabel .
464+ hnullify nullifier .
465+ gconstruct @_Table @_Columns @f @context @rep toColumns
466+
467+
468+instance {-# OVERLAPPABLE #-}
469+ ( HTable (GColumns _Columns rep)
470+ , GColumnsADT' _Columns htable (M1 C ('MetaCons label _fixity _isRecord) rep) ~
471+ HProduct htable (HLabel label (HNullify (GColumns _Columns rep)))
472+ )
473+ => GMakeableADT' _Table _Columns f context htable name (M1 C ('MetaCons label _fixity _isRecord) rep) fields
474+ where
475+ gmakeADT' _ null _ htable _ =
476+ HProduct htable $
477+ hlabel $
478+ hnulls null
src/Rel8/Generic/Construction/Record.hsnew file+168
@@ -0,0 +1,168 @@
1+{-# language AllowAmbiguousTypes #-}
2+{-# language BlockArguments #-}
3+{-# language DataKinds #-}
4+{-# language FlexibleInstances #-}
5+{-# language MultiParamTypeClasses #-}
6+{-# language RankNTypes #-}
7+{-# language ScopedTypeVariables #-}
8+{-# language StandaloneKindSignatures #-}
9+{-# language TypeApplications #-}
10+{-# language TypeFamilies #-}
11+{-# language TypeOperators #-}
12+{-# language UndecidableInstances #-}
13+
14+module Rel8.Generic.Construction.Record
15+ ( GConstructor, GConstruct, GConstructable, gconstruct, gdeconstruct
16+ , GFields, Representable, gtabulate, gindex
17+ , FromColumns, ToColumns
18+ )
19+where
20+
21+-- base
22+import Data.Kind ( Constraint, Type )
23+import Data.Proxy ( Proxy( Proxy ) )
24+import GHC.Generics
25+ ( (:*:), K1, M1, U1
26+ , D, C, S, Meta( MetaData, MetaCons, MetaSel )
27+ )
28+import GHC.TypeLits
29+ ( ErrorMessage( (:<>:), Text ), TypeError
30+ , Symbol
31+ )
32+import Prelude
33+
34+-- rel8
35+import Rel8.FCF ( Eval, Exp )
36+import Rel8.Generic.Table.Record ( GColumns )
37+import Rel8.Schema.HTable.Label ( hlabel, hunlabel )
38+import Rel8.Schema.HTable.Product ( HProduct( HProduct ) )
39+import qualified Rel8.Schema.Kind as K
40+
41+
42+type FromColumns
43+ :: (Type -> Exp Constraint)
44+ -> (Type -> Exp K.HTable)
45+ -> (Type -> Exp Type)
46+ -> K.Context
47+ -> Type
48+type FromColumns _Table _Columns f context = forall proxy x.
49+ Eval (_Table x) => proxy x -> Eval (_Columns x) context -> Eval (f x)
50+
51+
52+type ToColumns
53+ :: (Type -> Exp Constraint)
54+ -> (Type -> Exp K.HTable)
55+ -> (Type -> Exp Type)
56+ -> K.Context
57+ -> Type
58+type ToColumns _Table _Columns f context = forall proxy x.
59+ Eval (_Table x) => proxy x -> Eval (f x) -> Eval (_Columns x) context
60+
61+
62+type GConstructor :: (Type -> Type) -> Symbol
63+type family GConstructor rep where
64+ GConstructor (M1 D _ (M1 C ('MetaCons name _ _) _)) = name
65+ GConstructor (M1 D ('MetaData name _ _ _) _) = TypeError (
66+ 'Text "`" ':<>:
67+ 'Text name ':<>:
68+ 'Text "` does not appear to have exactly 1 constructor"
69+ )
70+
71+
72+type GConstruct :: (Type -> Exp Type) -> (Type -> Type) -> Type -> Type
73+type family GConstruct f rep r where
74+ GConstruct f (M1 _ _ rep) r = GConstruct f rep r
75+ GConstruct f (a :*: b) r = GConstruct f a (GConstruct f b r)
76+ GConstruct _ U1 r = r
77+ GConstruct f (K1 _ a) r = Eval (f a) -> r
78+
79+
80+type GFields :: (Type -> Exp Type) -> (Type -> Type) -> Type
81+type family GFields f rep where
82+ GFields f (M1 _ _ rep) = GFields f rep
83+ GFields f (a :*: b) = (GFields f a, GFields f b)
84+ GFields _ U1 = ()
85+ GFields f (K1 _ a) = Eval (f a)
86+
87+
88+type Representable :: (Type -> Exp Type) -> (Type -> Type) -> Constraint
89+class Representable f rep where
90+ gtabulate :: (GFields f rep -> a) -> GConstruct f rep a
91+ gindex :: GConstruct f rep a -> GFields f rep -> a
92+
93+
94+instance Representable f rep => Representable f (M1 i meta rep) where
95+ gtabulate = gtabulate @f @rep
96+ gindex = gindex @f @rep
97+
98+
99+instance (Representable f a, Representable f b) =>
100+ Representable f (a :*: b)
101+ where
102+ gtabulate f = gtabulate @f @a \a -> gtabulate @f @b \b -> f (a, b)
103+ gindex f (a, b) = gindex @f @b (gindex @f @a f a) b
104+
105+
106+instance Representable f U1 where
107+ gtabulate = ($ ())
108+ gindex = const
109+
110+
111+instance Representable f (K1 i a) where
112+ gtabulate = id
113+ gindex = id
114+
115+
116+type GConstructable
117+ :: (Type -> Exp Constraint)
118+ -> (Type -> Exp K.HTable)
119+ -> (Type -> Exp Type)
120+ -> K.Context -> (Type -> Type) -> Constraint
121+class GConstructable _Table _Columns f context rep where
122+ gconstruct :: ()
123+ => ToColumns _Table _Columns f context
124+ -> GFields f rep
125+ -> GColumns _Columns rep context
126+ gdeconstruct :: ()
127+ => FromColumns _Table _Columns f context
128+ -> GColumns _Columns rep context
129+ -> GFields f rep
130+
131+
132+instance (GConstructable _Table _Columns f context rep) =>
133+ GConstructable _Table _Columns f context (M1 D meta rep)
134+ where
135+ gconstruct = gconstruct @_Table @_Columns @f @context @rep
136+ gdeconstruct = gdeconstruct @_Table @_Columns @f @context @rep
137+
138+
139+instance (GConstructable _Table _Columns f context rep) =>
140+ GConstructable _Table _Columns f context (M1 C meta rep)
141+ where
142+ gconstruct = gconstruct @_Table @_Columns @f @context @rep
143+ gdeconstruct = gdeconstruct @_Table @_Columns @f @context @rep
144+
145+
146+instance
147+ ( GConstructable _Table _Columns f context a
148+ , GConstructable _Table _Columns f context b
149+ )
150+ => GConstructable _Table _Columns f context (a :*: b)
151+ where
152+ gconstruct toColumns (a, b) = HProduct
153+ (gconstruct @_Table @_Columns @f @context @a toColumns a)
154+ (gconstruct @_Table @_Columns @f @context @b toColumns b)
155+ gdeconstruct fromColumns (HProduct a b) =
156+ ( gdeconstruct @_Table @_Columns @f @context @a fromColumns a
157+ , gdeconstruct @_Table @_Columns @f @context @b fromColumns b
158+ )
159+
160+
161+instance
162+ ( Eval (_Table a)
163+ , meta ~ 'MetaSel ('Just label) _su _ss _ds
164+ )
165+ => GConstructable _Table _Columns f context (M1 S meta (K1 i a))
166+ where
167+ gconstruct toColumns = hlabel . toColumns (Proxy @a)
168+ gdeconstruct fromColumns = fromColumns (Proxy @a) . hunlabel
src/Rel8/Generic/Map.hs+20−64
@@ -1,26 +1,19 @@
1−{-# language AllowAmbiguousTypes #-}
2{-# language DataKinds #-}
1{-# language DataKinds #-}
3−{-# language EmptyCase #-}
4−{-# language FlexibleInstances #-}
5−{-# language LambdaCase #-}
6−{-# language MultiParamTypeClasses #-}
7−{-# language RankNTypes #-}
8−{-# language ScopedTypeVariables #-}
9{-# language StandaloneKindSignatures #-}
2{-# language StandaloneKindSignatures #-}
10−{-# language TypeApplications #-}
11{-# language TypeFamilies #-}
3{-# language TypeFamilies #-}
12{-# language TypeOperators #-}
4{-# language TypeOperators #-}
13{-# language UndecidableInstances #-}
5{-# language UndecidableInstances #-}
14
6
15module Rel8.Generic.Map
7module Rel8.Generic.Map
16− ( GMap, GMappable (gmap, gunmap)
8+ ( GMap
9+ , Map
17 )
10 )
18where
11where
19
12
20-- base
13-- base
21−import Data.Kind ( Constraint, Type )
14+import Data.Kind ( Type )
22import GHC.Generics
15import GHC.Generics
23− ( (:+:)( L1, R1 ), (:*:)( (:*:) ), K1( K1 ), M1( M1 ), U1( U1 ), V1
16+ ( (:+:), (:*:), K1, M1, U1, V1
24 )
17 )
25import Prelude ()
18import Prelude ()
26
19
@@ -38,56 +31,19 @@ type family GMap f rep where
38 GMap f (K1 i a) = K1 i (Eval (f a))
31 GMap f (K1 i a) = K1 i (Eval (f a))
39
32
40
33
41−type GMappable :: (Type -> Exp Constraint) -> (Type -> Type) -> Constraint
34+-- | Map a @Type -> Type@ function over the @Type@-kinded type variables in
42−class GMappable constraint rep where
35+-- of a type constructor.
43− gmap :: ()
36+type Map :: (Type -> Exp Type) -> Type -> Type
44− => proxy f
37+type family Map f a where
45− -> (forall a. Eval (constraint a) => a -> Eval (f a))
38+ Map p (t a b c d e f g) =
46− -> rep x
39+ t (Eval (p a)) (Eval (p b)) (Eval (p c)) (Eval (p d)) (Eval (p e))
47− -> GMap f rep x
40+ (Eval (p f)) (Eval (p g))
48−
41+ Map p (t a b c d e f) =
49− gunmap :: ()
42+ t (Eval (p a)) (Eval (p b)) (Eval (p c)) (Eval (p d)) (Eval (p e))
50− => proxy f
43+ (Eval (p f))
51− -> (forall a. Eval (constraint a) => Eval (f a) -> a)
44+ Map p (t a b c d e) =
52− -> GMap f rep x
45+ t (Eval (p a)) (Eval (p b)) (Eval (p c)) (Eval (p d)) (Eval (p e))
53− -> rep x
46+ Map p (t a b c d) = t (Eval (p a)) (Eval (p b)) (Eval (p c)) (Eval (p d))
54−
47+ Map p (t a b c) = t (Eval (p a)) (Eval (p b)) (Eval (p c))
55−
48+ Map p (t a b) = t (Eval (p a)) (Eval (p b))
56−instance GMappable constraint rep => GMappable constraint (M1 i c rep) where
49+ Map p (t a) = t (Eval (p a))
57− gmap proxy f (M1 a) = M1 (gmap @constraint proxy f a)
58− gunmap proxy f (M1 a) = M1 (gunmap @constraint proxy f a)
59−
60−
61−instance GMappable constraint V1 where
62− gmap _ _ = \case
63− gunmap _ _ = \case
64−
65−
66−instance (GMappable constraint rep1, GMappable constraint rep2) =>
67− GMappable constraint (rep1 :+: rep2)
68− where
69− gmap proxy f = \case
70− L1 a -> L1 (gmap @constraint proxy f a)
71− R1 a -> R1 (gmap @constraint proxy f a)
72− gunmap proxy f = \case
73− L1 a -> L1 (gunmap @constraint proxy f a)
74− R1 a -> R1 (gunmap @constraint proxy f a)
75−
76−
77−instance GMappable constraint U1 where
78− gmap _ _ U1 = U1
79− gunmap _ _ U1 = U1
80−
81−
82−instance (GMappable constraint rep1, GMappable constraint rep2) =>
83− GMappable constraint (rep1 :*: rep2)
84− where
85− gmap proxy f (a :*: b) =
86− gmap @constraint proxy f a :*: gmap @constraint proxy f b
87− gunmap proxy f (a :*: b) =
88− gunmap @constraint proxy f a :*: gunmap @constraint proxy f b
89−
90−
91−instance Eval (constraint a) => GMappable constraint (K1 i a) where
92− gmap _ f (K1 a) = K1 (f a)
93− gunmap _ f (K1 a) = K1 (f a)
src/Rel8/Generic/Record.hs+31−28
@@ -1,5 +1,6 @@
1{-# language AllowAmbiguousTypes #-}
1{-# language AllowAmbiguousTypes #-}
2{-# language DataKinds #-}
2{-# language DataKinds #-}
3+{-# language FlexibleContexts #-}
3{-# language FlexibleInstances #-}
4{-# language FlexibleInstances #-}
4{-# language MultiParamTypeClasses #-}
5{-# language MultiParamTypeClasses #-}
5{-# language PolyKinds #-}
6{-# language PolyKinds #-}
@@ -12,6 +13,7 @@
12
13
13module Rel8.Generic.Record
14module Rel8.Generic.Record
14 ( Record(..)
15 ( Record(..)
16+ , GRecordable, GRecord, grecord, gunrecord
15 )
17 )
16where
18where
17
19
@@ -26,13 +28,13 @@ import GHC.TypeLits ( type (+), AppendSymbol, Div, Mod, Nat, Symbol )
26import Prelude hiding ( Show )
28import Prelude hiding ( Show )
27
29
28
30
29−type Recordize :: (Type -> Type) -> Type -> Type
31+type GRecord :: (Type -> Type) -> Type -> Type
30−type family Recordize rep where
32+type family GRecord rep where
31− Recordize (M1 D meta rep) = M1 D meta (Recordize rep)
33+ GRecord (M1 D meta rep) = M1 D meta (GRecord rep)
32− Recordize (l :+: r) = Recordize l :+: Recordize r
34+ GRecord (l :+: r) = GRecord l :+: GRecord r
33− Recordize (M1 C ('MetaCons name fixity 'False) rep) =
35+ GRecord (M1 C ('MetaCons name fixity 'False) rep) =
34 M1 C ('MetaCons name fixity 'True) (Snd (Count 0 rep))
36 M1 C ('MetaCons name fixity 'True) (Snd (Count 0 rep))
35− Recordize rep = rep
37+ GRecord rep = rep
36
38
37
39
38type Count :: Nat -> (Type -> Type) -> (Nat, Type -> Type)
40type Count :: Nat -> (Type -> Type) -> (Nat, Type -> Type)
@@ -83,34 +85,34 @@ type family Snd tuple where
83 Snd '(_a, b) = b
85 Snd '(_a, b) = b
84
86
85
87
86−type Recordizable :: (Type -> Type) -> Constraint
88+type GRecordable :: (Type -> Type) -> Constraint
87−class Recordizable rep where
89+class GRecordable rep where
88− recordize :: rep x -> Recordize rep x
90+ grecord :: rep x -> GRecord rep x
89− unrecordize :: Recordize rep x -> rep x
91+ gunrecord :: GRecord rep x -> rep x
90
92
91
93
92−instance Recordizable rep => Recordizable (M1 D meta rep) where
94+instance GRecordable rep => GRecordable (M1 D meta rep) where
93− recordize (M1 a) = M1 (recordize a)
95+ grecord (M1 a) = M1 (grecord a)
94− unrecordize (M1 a) = M1 (unrecordize a)
96+ gunrecord (M1 a) = M1 (gunrecord a)
95
97
96
98
97−instance (Recordizable l, Recordizable r) => Recordizable (l :+: r) where
99+instance (GRecordable l, GRecordable r) => GRecordable (l :+: r) where
98− recordize (L1 a) = L1 (recordize a)
100+ grecord (L1 a) = L1 (grecord a)
99− recordize (R1 a) = R1 (recordize a)
101+ grecord (R1 a) = R1 (grecord a)
100− unrecordize (L1 a) = L1 (unrecordize a)
102+ gunrecord (L1 a) = L1 (gunrecord a)
101− unrecordize (R1 a) = R1 (unrecordize a)
103+ gunrecord (R1 a) = R1 (gunrecord a)
102
104
103
105
104instance Countable 0 rep =>
106instance Countable 0 rep =>
105− Recordizable (M1 C ('MetaCons name fixity 'False) rep)
107+ GRecordable (M1 C ('MetaCons name fixity 'False) rep)
106 where
108 where
107− recordize (M1 a) = M1 (count @0 a)
109+ grecord (M1 a) = M1 (count @0 a)
108− unrecordize (M1 a) = M1 (uncount @0 a)
110+ gunrecord (M1 a) = M1 (uncount @0 a)
109
111
110
112
111−instance {-# OVERLAPPABLE #-} Recordize rep ~ rep => Recordizable rep where
113+instance {-# OVERLAPPABLE #-} GRecord rep ~ rep => GRecordable rep where
112− recordize = id
114+ grecord = id
113− unrecordize = id
115+ gunrecord = id
114
116
115
117
116type Countable :: Nat -> (Type -> Type) -> Constraint
118type Countable :: Nat -> (Type -> Type) -> Constraint
@@ -140,13 +142,14 @@ instance {-# OVERLAPPABLE #-} Snd (Count n rep) ~ rep => Countable n rep where
140 uncount = id
142 uncount = id
141
143
142
144
145+type Record :: Type -> Type
143newtype Record a = Record
146newtype Record a = Record
144 { unrecord :: a
147 { unrecord :: a
145 }
148 }
146
149
147
150
148−instance (Generic a, Recordizable (Rep a)) => Generic (Record a) where
151+instance (Generic a, GRecordable (Rep a)) => Generic (Record a) where
149− type Rep (Record a) = Recordize (Rep a)
152+ type Rep (Record a) = GRecord (Rep a)
150
153
151− from (Record a) = recordize (from a)
154+ from (Record a) = grecord (from a)
152− to = Record . to . unrecordize
155+ to = Record . to . gunrecord
src/Rel8/Generic/Rel8able.hsnew file+281
@@ -0,0 +1,281 @@
1+{-# language AllowAmbiguousTypes #-}
2+{-# language ConstraintKinds #-}
3+{-# language DataKinds #-}
4+{-# language DefaultSignatures #-}
5+{-# language FlexibleContexts #-}
6+{-# language FlexibleInstances #-}
7+{-# language LambdaCase #-}
8+{-# language MultiParamTypeClasses #-}
9+{-# language PolyKinds #-}
10+{-# language QuantifiedConstraints #-}
11+{-# language ScopedTypeVariables #-}
12+{-# language StandaloneKindSignatures #-}
13+{-# language TypeApplications #-}
14+{-# language TypeFamilyDependencies #-}
15+{-# language TypeOperators #-}
16+{-# language UndecidableInstances #-}
17+
18+module Rel8.Generic.Rel8able
19+ ( KRel8able, Rel8able
20+ , Algebra
21+ , GRep
22+ , GColumns, gfromColumns, gtoColumns
23+ , GFromExprs, gfromResult, gtoResult
24+ , TSerialize, serialize, deserialize
25+ )
26+where
27+
28+-- base
29+import Data.Functor.Identity ( Identity )
30+import Data.Kind ( Constraint, Type )
31+import Data.Type.Bool ( type (&&) )
32+import GHC.Generics ( Generic, Rep, from, to )
33+import Prelude
34+
35+-- rel8
36+import Rel8.Aggregate ( Aggregate )
37+import Rel8.Expr ( Expr )
38+import Rel8.FCF ( Exp, Eval )
39+import Rel8.Generic.Record ( Record(..) )
40+import Rel8.Generic.Table ( GAlgebra )
41+import qualified Rel8.Generic.Table.Record as G
42+import qualified Rel8.Kind.Algebra as K ( Algebra(..) )
43+import Rel8.Kind.Context ( SContext(..) )
44+import Rel8.Schema.Field ( Field )
45+import Rel8.Schema.HTable ( HTable )
46+import qualified Rel8.Schema.Kind as K
47+import Rel8.Schema.Name ( Name )
48+import Rel8.Schema.Result ( Result )
49+import Rel8.Table
50+ ( Table, Columns, Context, fromColumns, toColumns
51+ , FromExprs, fromResult, toResult
52+ , Transpose
53+ , TTable, TColumns
54+ )
55+import Rel8.Table.Transpose ( Transposes )
56+
57+
58+-- | The kind of 'Rel8able' types
59+type KRel8able :: Type
60+type KRel8able = K.Rel8able
61+
62+
63+-- This is almost 'Data.Type.Equality.==', but we add an extra case.
64+type (==) :: k -> k -> Bool
65+type family a == b where
66+ -- This extra case is needed to solve the equation "a == a" (where a is a
67+ -- KRel8able), which occurs when we have polymorphic Rel8ables
68+ -- (e.g., newtype T t f = T { x :: t a })
69+ (a :: KRel8able) == (a :: KRel8able) = 'True
70+
71+ -- This extra case is needed to solve the equation "a == Identity a",
72+ -- which occurs when we have polymorphic Rel8ables
73+ -- (e.g., newtype T a f = T { x :: Column f a })
74+ a == Identity a = 'False
75+
76+ -- These cases are exactly the same as those in 'Data.Type.Equality.==.
77+ f a == g b = f == g && a == b
78+ a == a = 'True
79+ _ == _ = 'False
80+
81+
82+type Serialize :: Bool -> Type -> Type -> Constraint
83+class transposition ~ (a == Transpose Result expr) =>
84+ Serialize transposition expr a
85+ where
86+ serialize :: a -> Columns expr Result
87+ deserialize :: Columns expr Result -> a
88+
89+
90+instance
91+ ( (a == Transpose Result expr) ~ 'True
92+ , Transposes Expr Result expr a
93+ )
94+ => Serialize 'True expr a
95+ where
96+ serialize = toColumns
97+ deserialize = fromColumns
98+
99+
100+instance
101+ ( (a == Transpose Result expr) ~ 'False
102+ , Table (Context expr) expr
103+ , FromExprs expr ~ a
104+ )
105+ => Serialize 'False expr a
106+ where
107+ serialize = toResult @_ @expr
108+ deserialize = fromResult @_ @expr
109+
110+
111+data TSerialize :: Type -> Type -> Exp Constraint
112+type instance Eval (TSerialize expr a) =
113+ Serialize (a == Transpose Result expr) expr a
114+
115+
116+-- | This type class allows you to define custom 'Table's using higher-kinded
117+-- data types. Higher-kinded data types are data types of the pattern:
118+--
119+-- @
120+-- data MyType f =
121+-- MyType { field1 :: Column f T1 OR HK1 f
122+-- , field2 :: Column f T2 OR HK2 f
123+-- , ...
124+-- , fieldN :: Column f Tn OR HKn f
125+-- }
126+-- @
127+--
128+-- where @Tn@ is any Haskell type, and @HKn@ is any higher-kinded type.
129+--
130+-- That is, higher-kinded data are records where all fields in the record are
131+-- all either of the type @Column f T@ (for any @T@), or are themselves
132+-- higher-kinded data:
133+--
134+-- [Nested]
135+--
136+-- @
137+-- data Nested f =
138+-- Nested { nested1 :: MyType f
139+-- , nested2 :: MyType f
140+-- }
141+-- @
142+--
143+-- The @Rel8able@ type class is used to give us a special mapping operation
144+-- that lets us change the type parameter @f@.
145+--
146+-- [Supplying @Rel8able@ instances]
147+--
148+-- This type class should be derived generically for all table types in your
149+-- project. To do this, enable the @DeriveAnyClass@ and @DeriveGeneric@ language
150+-- extensions:
151+--
152+-- @
153+-- \{\-\# LANGUAGE DeriveAnyClass, DeriveGeneric #-\}
154+--
155+-- data MyType f = MyType { fieldA :: Column f T }
156+-- deriving ( GHC.Generics.Generic, Rel8able )
157+-- @
158+type Rel8able :: K.Rel8able -> Constraint
159+class HTable (GColumns t) => Rel8able t where
160+ type GColumns t :: K.HTable
161+ type GFromExprs t :: Type
162+
163+ gfromColumns :: SContext context -> GColumns t context -> t context
164+ gtoColumns :: SContext context -> t context -> GColumns t context
165+
166+ gfromResult :: GColumns t Result -> GFromExprs t
167+ gtoResult :: GFromExprs t -> GColumns t Result
168+
169+ type GColumns t = G.GColumns TColumns (GRep t Expr)
170+ type GFromExprs t = t Result
171+
172+ default gfromColumns :: forall context.
173+ ( SRel8able t Aggregate
174+ , SRel8able t Expr
175+ , forall table. SRel8able t (Field table)
176+ , SRel8able t Name
177+ , SSerialize t
178+ )
179+ => SContext context -> GColumns t context -> t context
180+ gfromColumns = \case
181+ SAggregate -> sfromColumns
182+ SExpr -> sfromColumns
183+ SField -> sfromColumns
184+ SName -> sfromColumns
185+ SResult -> sfromResult
186+
187+ default gtoColumns :: forall context.
188+ ( SRel8able t Aggregate
189+ , SRel8able t Expr
190+ , forall table. SRel8able t (Field table)
191+ , SRel8able t Name
192+ , SSerialize t
193+ )
194+ => SContext context -> t context -> GColumns t context
195+ gtoColumns = \case
196+ SAggregate -> stoColumns
197+ SExpr -> stoColumns
198+ SField -> stoColumns
199+ SName -> stoColumns
200+ SResult -> stoResult
201+
202+ default gfromResult :: (SSerialize t, GFromExprs t ~ t Result)
203+ => GColumns t Result -> GFromExprs t
204+ gfromResult = sfromResult
205+
206+ default gtoResult :: (SSerialize t, GFromExprs t ~ t Result)
207+ => GFromExprs t -> GColumns t Result
208+ gtoResult = stoResult
209+
210+
211+type Algebra :: K.Rel8able -> K.Algebra
212+type Algebra t = GAlgebra (GRep t Expr)
213+
214+
215+type GRep :: K.Rel8able -> K.Context -> Type -> Type
216+type GRep t context = Rep (Record (t context))
217+
218+
219+type SRel8able :: K.Rel8able -> K.Context -> Constraint
220+class
221+ ( Generic (Record (t context))
222+ , G.GTable (TTable context) TColumns (GRep t context)
223+ , G.GColumns TColumns (GRep t context) ~ GColumns t
224+ )
225+ => SRel8able t context
226+instance
227+ ( Generic (Record (t context))
228+ , G.GTable (TTable context) TColumns (GRep t context)
229+ , G.GColumns TColumns (GRep t context) ~ GColumns t
230+ )
231+ => SRel8able t context
232+
233+
234+type SSerialize :: K.Rel8able -> Constraint
235+type SSerialize t =
236+ ( Generic (Record (t Result))
237+ , G.GSerialize TSerialize TColumns (GRep t Expr) (GRep t Result)
238+ , G.GColumns TColumns (GRep t Expr) ~ GColumns t
239+ )
240+
241+
242+sfromColumns :: forall t context. SRel8able t context
243+ => GColumns t context -> t context
244+sfromColumns =
245+ unrecord .
246+ to .
247+ G.gfromColumns @(TTable context) @TColumns fromColumns
248+
249+
250+stoColumns :: forall t context. SRel8able t context
251+ => t context -> GColumns t context
252+stoColumns =
253+ G.gtoColumns @(TTable context) @TColumns toColumns .
254+ from .
255+ Record
256+
257+
258+sfromResult :: forall t. SSerialize t
259+ => GColumns t Result -> t Result
260+sfromResult =
261+ unrecord .
262+ to .
263+ G.gfromResult
264+ @TSerialize
265+ @TColumns
266+ @(GRep t Expr)
267+ @(GRep t Result)
268+ (\(_ :: proxy x) -> deserialize @_ @x)
269+
270+
271+stoResult :: forall t. SSerialize t
272+ => t Result -> GColumns t Result
273+stoResult =
274+ G.gtoResult
275+ @TSerialize
276+ @TColumns
277+ @(GRep t Expr)
278+ @(GRep t Result)
279+ (\(_ :: proxy x) -> serialize @_ @x) .
280+ from .
281+ Record
src/Rel8/Generic/Table.hs+72−95
@@ -1,8 +1,8 @@
1{-# language AllowAmbiguousTypes #-}
1{-# language AllowAmbiguousTypes #-}
2{-# language DataKinds #-}
2{-# language DataKinds #-}
3+{-# language FlexibleContexts #-}
3{-# language FlexibleInstances #-}
4{-# language FlexibleInstances #-}
4{-# language MultiParamTypeClasses #-}
5{-# language MultiParamTypeClasses #-}
5−{-# language PolyKinds #-}
6{-# language RankNTypes #-}
6{-# language RankNTypes #-}
7{-# language ScopedTypeVariables #-}
7{-# language ScopedTypeVariables #-}
8{-# language StandaloneKindSignatures #-}
8{-# language StandaloneKindSignatures #-}
@@ -12,115 +12,92 @@
12{-# language UndecidableInstances #-}
12{-# language UndecidableInstances #-}
13
13
14module Rel8.Generic.Table
14module Rel8.Generic.Table
15− ( GTable, GColumns, GContext, fromGColumns, toGColumns, gtable
15+ ( GGSerialize, GGColumns, ggfromResult, ggtoResult
16+ , GAlgebra
16 )
17 )
17where
18where
18
19
19-- base
20-- base
20import Data.Kind ( Constraint, Type )
21import Data.Kind ( Constraint, Type )
21−import Data.Proxy ( Proxy( Proxy ) )
22+import GHC.Generics ( (:+:), (:*:), K1, M1, U1, V1 )
22−import GHC.Generics
23+import Prelude ()
23− ( (:*:)( (:*:) ), K1( K1 ), M1( M1 )
24− , C, D, S
25− , Meta( MetaSel )
26− )
27−import GHC.TypeLits ( KnownSymbol )
28−import Prelude hiding ( null )
29
24
30-- rel8
25-- rel8
31import Rel8.FCF ( Eval, Exp )
26import Rel8.FCF ( Eval, Exp )
32−import Rel8.Schema.Context.Label ( HLabelable, hlabeler, hunlabeler )
27+import Rel8.Generic.Table.ADT
33−import Rel8.Schema.HTable ( HTable )
28+ ( GSerializeADT, GColumnsADT, gtoResultADT, gfromResultADT
34−import Rel8.Schema.HTable.Label ( HLabel, hlabel, hunlabel )
29+ )
35−import Rel8.Schema.HTable.Product ( HProduct(..) )
30+import Rel8.Generic.Table.Record ( GSerialize, GColumns, gtoResult, gfromResult )
31+import Rel8.Kind.Algebra
32+ ( Algebra( Product, Sum )
33+ , SAlgebra( SProduct, SSum )
34+ , KnownAlgebra, algebraSing
35+ )
36import qualified Rel8.Schema.Kind as K
36import qualified Rel8.Schema.Kind as K
37+import Rel8.Schema.Result ( Result )
37
38
38
39
39−type GColumns :: (Type -> Exp K.HTable) -> (Type -> Type) -> K.HTable
40+data GGSerialize
40−type family GColumns _Columns rep where
41+ :: Algebra
41− GColumns _Columns (M1 D _ rep) = GColumns _Columns rep
42+ -> (Type -> Type -> Exp Constraint)
42− GColumns _Columns (M1 C _ rep) = GColumns _Columns rep
43+ -> (Type -> Exp K.HTable)
43− GColumns _Columns (rep1 :*: rep2) =
44+ -> (Type -> Type)
44− HProduct (GColumns _Columns rep1) (GColumns _Columns rep2)
45+ -> (Type -> Type)
45− GColumns _Columns (M1 S ('MetaSel ('Just label) _ _ _) (K1 _ a)) =
46+ -> Exp Constraint
46− HLabel label (Eval (_Columns a))
47
47
48
48
49−type GContext :: (Type -> Exp a) -> (Type -> Type) -> a
49+type instance Eval (GGSerialize 'Product _Serialize _Columns exprs rep) =
50−type family GContext _Context rep where
50+ GSerialize _Serialize _Columns exprs rep
51− GContext _Context (M1 _ _ rep) = GContext _Context rep
52− GContext _Context (rep1 :*: _rep2) = GContext _Context rep1
53− GContext _Context (K1 _ a) = Eval (_Context a)
54
51
55
52
56−type GTable
53+type instance Eval (GGSerialize 'Sum _Serialize _Columns exprs rep) =
57− :: (Type -> Exp Constraint)
54+ GSerializeADT _Serialize _Columns exprs rep
55+
56+
57+data GGColumns
58+ :: Algebra
58 -> (Type -> Exp K.HTable)
59 -> (Type -> Exp K.HTable)
59− -> K.HContext -> (Type -> Type) -> Constraint
60+ -> (Type -> Type)
60−class GTable _Table _Columns context rep
61+ -> Exp K.HTable
61− where
62+
62− fromGColumns :: ()
63+
63− => (forall a. Eval (_Table a) => Eval (_Columns a) context -> a)
64+type instance Eval (GGColumns 'Product _Columns rep) = GColumns _Columns rep
64− -> GColumns _Columns rep context
65+
65− -> rep x
66+
66−
67+type instance Eval (GGColumns 'Sum _Columns rep) = GColumnsADT _Columns rep
67− toGColumns :: ()
68+
68− => (forall a. Eval (_Table a) => a -> Eval (_Columns a) context)
69+
69− -> rep x
70+type GAlgebra :: (Type -> Type) -> Algebra
70− -> GColumns _Columns rep context
71+type family GAlgebra rep where
71−
72+ GAlgebra (M1 _ _ rep) = GAlgebra rep
72− gtable :: ()
73+ GAlgebra V1 = 'Sum
73− => (forall a. Eval (_Table a) => Proxy a -> Eval (_Columns a) context)
74+ GAlgebra (_ :+: _) = 'Sum
74− -> GColumns _Columns rep context
75+ GAlgebra U1 = 'Sum
75−
76+ GAlgebra (_ :*: _) = 'Product
76−
77+ GAlgebra (K1 _ _) = 'Product
77−instance GTable _Table _Columns context rep =>
78+
78− GTable _Table _Columns context (M1 D c rep)
79+
79− where
80+ggfromResult :: forall algebra _Serialize _Columns exprs rep x.
80− fromGColumns fromColumns =
81+ ( KnownAlgebra algebra
81− M1 . fromGColumns @_Table @_Columns @context @rep fromColumns
82+ , Eval (GGSerialize algebra _Serialize _Columns exprs rep)
82− toGColumns toColumns (M1 a) =
83− toGColumns @_Table @_Columns @context @rep toColumns a
84− gtable = gtable @_Table @_Columns @context @rep
85−
86−
87−instance GTable _Table _Columns context rep =>
88− GTable _Table _Columns context (M1 C c rep)
89− where
90− fromGColumns fromColumns =
91− M1 . fromGColumns @_Table @_Columns @context @rep fromColumns
92− toGColumns toColumns (M1 a) =
93− toGColumns @_Table @_Columns @context @rep toColumns a
94− gtable = gtable @_Table @_Columns @context @rep
95−
96−
97−instance
98− ( GTable _Table _Columns context rep1
99− , GTable _Table _Columns context rep2
100 )
83 )
101− => GTable _Table _Columns context (rep1 :*: rep2)
84+ => (forall expr a proxy. Eval (_Serialize expr a)
102− where
85+ => proxy expr -> Eval (_Columns expr) Result -> a)
103− fromGColumns fromColumns (HProduct a b) =
86+ -> Eval (GGColumns algebra _Columns exprs) Result
104− fromGColumns @_Table @_Columns @context @rep1 fromColumns a :*:
87+ -> rep x
105− fromGColumns @_Table @_Columns @context @rep2 fromColumns b
88+ggfromResult f x = case algebraSing @algebra of
106− toGColumns toColumns (a :*: b) = HProduct
89+ SProduct -> gfromResult @_Serialize @_Columns @exprs @rep f x
107− (toGColumns @_Table @_Columns @context @rep1 toColumns a)
90+ SSum -> gfromResultADT @_Serialize @_Columns @exprs @rep f x
108− (toGColumns @_Table @_Columns @context @rep2 toColumns b)
91+
109− gtable table = HProduct
92+
110− (gtable @_Table @_Columns @context @rep1 table)
93+ggtoResult :: forall algebra _Serialize _Columns exprs rep x.
111− (gtable @_Table @_Columns @context @rep2 table)
94+ ( KnownAlgebra algebra
112−
95+ , Eval (GGSerialize algebra _Serialize _Columns exprs rep)
113−
114−instance
115− ( HTable (Eval (_Columns a))
116− , Eval (_Table a)
117− , HLabelable context
118− , KnownSymbol label
119− , meta ~ 'MetaSel ('Just label) _su _ss _ds
120− , k1 ~ K1 i a
121 )
96 )
122− => GTable _Table _Columns context (M1 S meta k1)
97+ => (forall expr a proxy. Eval (_Serialize expr a)
123− where
98+ => proxy expr -> a -> Eval (_Columns expr) Result)
124− fromGColumns fromColumns = M1 . K1 . fromColumns . hunlabel hunlabeler
99+ -> rep x
125− toGColumns toColumns (M1 (K1 a)) = hlabel hlabeler (toColumns a)
100+ -> Eval (GGColumns algebra _Columns exprs) Result
126− gtable table = hlabel hlabeler (table (Proxy @a))
101+ggtoResult f x = case algebraSing @algebra of
102+ SProduct -> gtoResult @_Serialize @_Columns @exprs @rep f x
103+ SSum -> gtoResultADT @_Serialize @_Columns @exprs @rep f x
src/Rel8/Generic/Table/ADT.hsnew file+221
@@ -0,0 +1,221 @@
1+{-# language AllowAmbiguousTypes #-}
2+{-# language DataKinds #-}
3+{-# language FlexibleContexts #-}
4+{-# language FlexibleInstances #-}
5+{-# language LambdaCase #-}
6+{-# language MultiParamTypeClasses #-}
7+{-# language RankNTypes #-}
8+{-# language ScopedTypeVariables #-}
9+{-# language StandaloneKindSignatures #-}
10+{-# language TypeApplications #-}
11+{-# language TypeFamilies #-}
12+{-# language TypeOperators #-}
13+{-# language UndecidableInstances #-}
14+
15+module Rel8.Generic.Table.ADT
16+ ( GSerializeADT, GColumnsADT, gfromResultADT, gtoResultADT
17+ , GSerializeADT', GColumnsADT'
18+ )
19+where
20+
21+-- base
22+import Data.Functor.Identity ( Identity( Identity ) )
23+import Data.Kind ( Constraint, Type )
24+import Data.Proxy ( Proxy( Proxy ) )
25+import GHC.Generics
26+ ( (:+:)( L1, R1 ), M1( M1 ), U1( U1 )
27+ , C, D
28+ , Meta( MetaCons )
29+ )
30+import GHC.TypeLits ( KnownSymbol, symbolVal )
31+import Prelude hiding ( null )
32+
33+-- rel8
34+import Rel8.FCF ( Eval, Exp )
35+import Rel8.Generic.Table.Record ( GSerialize, GColumns, gfromResult, gtoResult )
36+import Rel8.Schema.HTable ( HTable )
37+import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
38+import Rel8.Schema.HTable.Label ( HLabel, hlabel, hunlabel )
39+import Rel8.Schema.HTable.Nullify ( HNullify, hnulls, hnullify, hunnullify )
40+import Rel8.Schema.HTable.Product ( HProduct( HProduct ) )
41+import qualified Rel8.Schema.Kind as K
42+import Rel8.Schema.Result ( Result, null, nullifier, unnullifier )
43+import Rel8.Type.Tag ( Tag( Tag ) )
44+
45+-- text
46+import Data.Text ( pack )
47+
48+
49+type GColumnsADT
50+ :: (Type -> Exp K.HTable)
51+ -> (Type -> Type) -> K.HTable
52+type family GColumnsADT _Columns rep where
53+ GColumnsADT _Columns (M1 D _ rep) =
54+ GColumnsADT' _Columns (HLabel "tag" (HIdentity Tag)) rep
55+
56+
57+type GColumnsADT'
58+ :: (Type -> Exp K.HTable)
59+ -> K.HTable -> (Type -> Type) -> K.HTable
60+type family GColumnsADT' _Columns htable rep where
61+ GColumnsADT' _Columns htable (a :+: b) =
62+ GColumnsADT' _Columns (GColumnsADT' _Columns htable a) b
63+ GColumnsADT' _Columns htable (M1 C ('MetaCons _ _ _) U1) = htable
64+ GColumnsADT' _Columns htable (M1 C ('MetaCons label _ _) rep) =
65+ HProduct htable (HLabel label (HNullify (GColumns _Columns rep)))
66+
67+
68+type GSerializeADT
69+ :: (Type -> Type -> Exp Constraint)
70+ -> (Type -> Exp K.HTable)
71+ -> (Type -> Type) -> (Type -> Type) -> Constraint
72+class GSerializeADT _Serialize _Columns exprs rep where
73+ gfromResultADT :: ()
74+ => (forall expr a proxy. Eval (_Serialize expr a)
75+ => proxy expr -> Eval (_Columns expr) Result -> a)
76+ -> GColumnsADT _Columns exprs Result
77+ -> rep x
78+
79+ gtoResultADT :: ()
80+ => (forall expr a proxy. Eval (_Serialize expr a)
81+ => proxy expr -> a -> Eval (_Columns expr) Result)
82+ -> rep x
83+ -> GColumnsADT _Columns exprs Result
84+
85+
86+instance
87+ ( htable ~ HLabel "tag" (HIdentity Tag)
88+ , GSerializeADT' _Serialize _Columns htable exprs rep
89+ )
90+ => GSerializeADT _Serialize _Columns (M1 D meta exprs) (M1 D meta rep)
91+ where
92+ gfromResultADT fromResult columns =
93+ case gfromResultADT' @_Serialize @_Columns @htable @exprs @rep fromResult tag columns of
94+ Just rep -> M1 rep
95+ _ -> error "ADT.fromColumns: mismatch between tag and data"
96+ where
97+ tag = (\(HIdentity (Identity a)) -> a) . hunlabel @"tag"
98+
99+ gtoResultADT toResult (M1 rep) =
100+ gtoResultADT' @_Serialize @_Columns @htable @exprs @rep toResult tag (Just rep)
101+ where
102+ tag = hlabel @"tag" . HIdentity . Identity
103+
104+
105+type GSerializeADT'
106+ :: (Type -> Type -> Exp Constraint)
107+ -> (Type -> Exp K.HTable)
108+ -> K.HTable -> (Type -> Type) -> (Type -> Type) -> Constraint
109+class GSerializeADT' _Serialize _Columns htable exprs rep where
110+ gfromResultADT' :: context ~ Result
111+ => (forall expr a proxy. Eval (_Serialize expr a)
112+ => proxy expr -> Eval (_Columns expr) context -> a)
113+ -> (htable Result -> Tag)
114+ -> GColumnsADT' _Columns htable exprs context
115+ -> Maybe (rep x)
116+
117+ gtoResultADT' :: context ~ Result
118+ => (forall expr a proxy. Eval (_Serialize expr a)
119+ => proxy expr -> a -> Eval (_Columns expr) context)
120+ -> (Tag -> htable Result)
121+ -> Maybe (rep x)
122+ -> GColumnsADT' _Columns htable exprs context
123+
124+ extract :: GColumnsADT' _Columns htable exprs context -> htable context
125+
126+
127+instance
128+ ( htable' ~ GColumnsADT' _Columns htable exprs1
129+ , GSerializeADT' _Serialize _Columns htable exprs1 a
130+ , GSerializeADT' _Serialize _Columns htable' exprs2 b
131+ )
132+ => GSerializeADT' _Serialize _Columns htable (exprs1 :+: exprs2) (a :+: b)
133+ where
134+ gfromResultADT' fromResult f columns =
135+ case ma of
136+ Just a -> Just (L1 a)
137+ Nothing -> R1 <$>
138+ gfromResultADT' @_Serialize @_Columns @_ @exprs2 @b
139+ fromResult
140+ (f . extract @_Serialize @_Columns @_ @exprs1 @a)
141+ columns
142+ where
143+ ma =
144+ gfromResultADT' @_Serialize @_Columns @_ @exprs1 @a
145+ fromResult
146+ f
147+ (extract @_Serialize @_Columns @_ @exprs2 @b columns)
148+
149+ gtoResultADT' toResult tag = \case
150+ Just (L1 a) ->
151+ gtoResultADT' @_Serialize @_Columns @_ @exprs2 @b
152+ toResult
153+ (\_ -> gtoResultADT' @_Serialize @_Columns @_ @exprs1 @a
154+ toResult
155+ tag
156+ (Just a))
157+ Nothing
158+ Just (R1 b) ->
159+ gtoResultADT' @_Serialize @_Columns @_ @exprs2 @b
160+ toResult
161+ (\tag' ->
162+ gtoResultADT' @_Serialize @_Columns @_ @exprs1 @a
163+ toResult
164+ (\_ -> tag tag')
165+ Nothing)
166+ (Just b)
167+ Nothing ->
168+ gtoResultADT' @_Serialize @_Columns @_ @exprs2 @b
169+ toResult
170+ (\_ -> gtoResultADT' @_Serialize @_Columns @_ @exprs1 @a toResult tag Nothing)
171+ Nothing
172+
173+ extract =
174+ extract @_Serialize @_Columns @_ @exprs1 @a .
175+ extract @_Serialize @_Columns @_ @exprs2 @b
176+
177+
178+instance (meta ~ 'MetaCons label _fixity _isRecord, KnownSymbol label) =>
179+ GSerializeADT' _Serialize _Columns _htable (M1 C meta U1) (M1 C meta U1)
180+ where
181+ gfromResultADT' _ tag columns
182+ | tag columns == tag' = Just (M1 U1)
183+ | otherwise = Nothing
184+ where
185+ tag' = Tag $ pack $ symbolVal (Proxy @label)
186+
187+ gtoResultADT' _ tag _ = tag tag'
188+ where
189+ tag' = Tag $ pack $ symbolVal (Proxy @label)
190+
191+ extract = id
192+
193+
194+instance {-# OVERLAPPABLE #-}
195+ ( HTable (GColumns _Columns exprs)
196+ , GSerialize _Serialize _Columns exprs rep
197+ , meta ~ 'MetaCons label _fixity _isRecord
198+ , KnownSymbol label
199+ , GColumnsADT' _Columns htable (M1 C ('MetaCons label _fixity _isRecord) exprs) ~
200+ HProduct htable (HLabel label (HNullify (GColumns _Columns exprs)))
201+ )
202+ => GSerializeADT' _Serialize _Columns htable (M1 C meta exprs) (M1 C meta rep)
203+ where
204+ gfromResultADT' fromResult tag (HProduct a b)
205+ | tag a == tag' =
206+ M1 . gfromResult @_Serialize @_Columns @exprs @rep fromResult <$>
207+ hunnullify unnullifier (hunlabel b)
208+ | otherwise = Nothing
209+ where
210+ tag' = Tag $ pack $ symbolVal (Proxy @label)
211+
212+ gtoResultADT' toResult tag = \case
213+ Nothing -> HProduct (tag tag') (hlabel (hnulls (const null)))
214+ Just (M1 rep) -> HProduct (tag tag') $
215+ hlabel $
216+ hnullify nullifier $
217+ gtoResult @_Serialize @_Columns @exprs @rep toResult rep
218+ where
219+ tag' = Tag $ pack $ symbolVal (Proxy @label)
220+
221+ extract (HProduct a _) = a
src/Rel8/Generic/Table/Record.hsnew file+181
@@ -0,0 +1,181 @@
1+{-# language AllowAmbiguousTypes #-}
2+{-# language DataKinds #-}
3+{-# language FlexibleContexts #-}
4+{-# language FlexibleInstances #-}
5+{-# language MultiParamTypeClasses #-}
6+{-# language PolyKinds #-}
7+{-# language RankNTypes #-}
8+{-# language ScopedTypeVariables #-}
9+{-# language StandaloneKindSignatures #-}
10+{-# language TypeApplications #-}
11+{-# language TypeFamilies #-}
12+{-# language TypeOperators #-}
13+{-# language UndecidableInstances #-}
14+
15+module Rel8.Generic.Table.Record
16+ ( GTable, GColumns, GContext, gfromColumns, gtoColumns, gtable
17+ , GSerialize, gfromResult, gtoResult
18+ )
19+where
20+
21+-- base
22+import Data.Kind ( Constraint, Type )
23+import Data.Proxy ( Proxy( Proxy ) )
24+import GHC.Generics
25+ ( (:*:)( (:*:) ), K1( K1 ), M1( M1 )
26+ , C, D, S
27+ , Meta( MetaSel )
28+ )
29+import Prelude hiding ( null )
30+
31+-- rel8
32+import Rel8.FCF ( Eval, Exp )
33+import Rel8.Schema.HTable.Label ( HLabel, hlabel, hunlabel )
34+import Rel8.Schema.HTable.Product ( HProduct(..) )
35+import qualified Rel8.Schema.Kind as K
36+
37+
38+type GColumns :: (Type -> Exp K.HTable) -> (Type -> Type) -> K.HTable
39+type family GColumns _Columns rep where
40+ GColumns _Columns (M1 D _ rep) = GColumns _Columns rep
41+ GColumns _Columns (M1 C _ rep) = GColumns _Columns rep
42+ GColumns _Columns (rep1 :*: rep2) =
43+ HProduct (GColumns _Columns rep1) (GColumns _Columns rep2)
44+ GColumns _Columns (M1 S ('MetaSel ('Just label) _ _ _) (K1 _ a)) =
45+ HLabel label (Eval (_Columns a))
46+
47+
48+type GContext :: (Type -> Exp K.Context) -> (Type -> Type) -> K.Context
49+type family GContext _Context rep where
50+ GContext _Context (M1 _ _ rep) = GContext _Context rep
51+ GContext _Context (rep1 :*: _rep2) = GContext _Context rep1
52+ GContext _Context (K1 _ a) = Eval (_Context a)
53+
54+
55+type GTable
56+ :: (Type -> Exp Constraint)
57+ -> (Type -> Exp K.HTable)
58+ -> (Type -> Type) -> Constraint
59+class GTable _Table _Columns rep
60+ where
61+ gfromColumns :: ()
62+ => (forall a. Eval (_Table a) => Eval (_Columns a) context -> a)
63+ -> GColumns _Columns rep context
64+ -> rep x
65+
66+ gtoColumns :: ()
67+ => (forall a. Eval (_Table a) => a -> Eval (_Columns a) context)
68+ -> rep x
69+ -> GColumns _Columns rep context
70+
71+ gtable :: ()
72+ => (forall a proxy. Eval (_Table a) => proxy a -> Eval (_Columns a) context)
73+ -> GColumns _Columns rep context
74+
75+
76+type GSerialize
77+ :: (Type -> Type -> Exp Constraint)
78+ -> (Type -> Exp K.HTable)
79+ -> (Type -> Type) -> (Type -> Type) -> Constraint
80+class GSerialize _Serialize _Columns exprs rep
81+ where
82+ gfromResult :: ()
83+ => (forall expr a proxy. Eval (_Serialize expr a)
84+ => proxy expr -> Eval (_Columns expr) context -> a)
85+ -> GColumns _Columns exprs context
86+ -> rep x
87+
88+ gtoResult :: ()
89+ => (forall expr a proxy. Eval (_Serialize expr a)
90+ => proxy expr -> a -> Eval (_Columns expr) context)
91+ -> rep x
92+ -> GColumns _Columns exprs context
93+
94+
95+instance GTable _Table _Columns rep => GTable _Table _Columns (M1 D c rep)
96+ where
97+ gfromColumns fromColumns =
98+ M1 . gfromColumns @_Table @_Columns @rep fromColumns
99+ gtoColumns toColumns (M1 a) =
100+ gtoColumns @_Table @_Columns @rep toColumns a
101+ gtable = gtable @_Table @_Columns @rep
102+
103+
104+instance GSerialize _Serialize _Columns exprs rep =>
105+ GSerialize _Serialize _Columns (M1 D c exprs) (M1 D c rep)
106+ where
107+ gfromResult fromResult =
108+ M1 . gfromResult @_Serialize @_Columns @exprs @rep fromResult
109+ gtoResult toResult (M1 a) =
110+ gtoResult @_Serialize @_Columns @exprs @rep toResult a
111+
112+
113+instance GTable _Table _Columns rep => GTable _Table _Columns (M1 C c rep)
114+ where
115+ gfromColumns fromColumns =
116+ M1 . gfromColumns @_Table @_Columns @rep fromColumns
117+ gtoColumns toColumns (M1 a) =
118+ gtoColumns @_Table @_Columns @rep toColumns a
119+ gtable = gtable @_Table @_Columns @rep
120+
121+
122+instance GSerialize _Serialize _Columns exprs rep =>
123+ GSerialize _Serialize _Columns (M1 C c exprs) (M1 C c rep)
124+ where
125+ gfromResult fromResult =
126+ M1 . gfromResult @_Serialize @_Columns @exprs @rep fromResult
127+ gtoResult toResult (M1 a) =
128+ gtoResult @_Serialize @_Columns @exprs @rep toResult a
129+
130+
131+instance (GTable _Table _Columns rep1, GTable _Table _Columns rep2) =>
132+ GTable _Table _Columns (rep1 :*: rep2)
133+ where
134+ gfromColumns fromColumns (HProduct a b) =
135+ gfromColumns @_Table @_Columns @rep1 fromColumns a :*:
136+ gfromColumns @_Table @_Columns @rep2 fromColumns b
137+ gtoColumns toColumns (a :*: b) = HProduct
138+ (gtoColumns @_Table @_Columns @rep1 toColumns a)
139+ (gtoColumns @_Table @_Columns @rep2 toColumns b)
140+ gtable table = HProduct
141+ (gtable @_Table @_Columns @rep1 table)
142+ (gtable @_Table @_Columns @rep2 table)
143+
144+
145+instance
146+ ( GSerialize _Serialize _Columns expr1 rep1
147+ , GSerialize _Serialize _Columns expr2 rep2
148+ )
149+ => GSerialize _Serialize _Columns (expr1 :*: expr2) (rep1 :*: rep2)
150+ where
151+ gfromResult fromResult (HProduct a b) =
152+ gfromResult @_Serialize @_Columns @expr1 @rep1 fromResult a :*:
153+ gfromResult @_Serialize @_Columns @expr2 @rep2 fromResult b
154+ gtoResult toResult (a :*: b) =
155+ HProduct
156+ (gtoResult @_Serialize @_Columns @expr1 @rep1 toResult a)
157+ (gtoResult @_Serialize @_Columns @expr2 @rep2 toResult b)
158+
159+
160+instance
161+ ( Eval (_Table a)
162+ , meta ~ 'MetaSel ('Just label) _su _ss _ds
163+ , k1 ~ K1 i a
164+ )
165+ => GTable _Table _Columns (M1 S meta k1)
166+ where
167+ gfromColumns fromColumns = M1 . K1 . fromColumns . hunlabel
168+ gtoColumns toColumns (M1 (K1 a)) = hlabel (toColumns a)
169+ gtable table = hlabel (table (Proxy @a))
170+
171+
172+instance
173+ ( Eval (_Serialize expr a)
174+ , meta ~ 'MetaSel ('Just label) _su _ss _ds
175+ , k1 ~ K1 i expr
176+ , k1' ~ K1 i a
177+ )
178+ => GSerialize _Serialize _Columns (M1 S meta k1) (M1 S meta k1')
179+ where
180+ gfromResult fromResult = M1 . K1 . fromResult (Proxy @expr) . hunlabel
181+ gtoResult toResult (M1 (K1 a)) = hlabel (toResult (Proxy @expr) a)
src/Rel8/Kind/Algebra.hsnew file+38
@@ -0,0 +1,38 @@
1+{-# language DataKinds #-}
2+{-# language FlexibleContexts #-}
3+{-# language GADTs #-}
4+{-# language StandaloneKindSignatures #-}
5+
6+module Rel8.Kind.Algebra
7+ ( Algebra( Product, Sum )
8+ , SAlgebra( SProduct, SSum )
9+ , KnownAlgebra( algebraSing )
10+ )
11+where
12+
13+-- base
14+import Data.Kind ( Constraint, Type )
15+import Prelude ()
16+
17+
18+type Algebra :: Type
19+data Algebra = Product | Sum
20+
21+
22+type SAlgebra :: Algebra -> Type
23+data SAlgebra algebra where
24+ SProduct :: SAlgebra 'Product
25+ SSum :: SAlgebra 'Sum
26+
27+
28+type KnownAlgebra :: Algebra -> Constraint
29+class KnownAlgebra algebra where
30+ algebraSing :: SAlgebra algebra
31+
32+
33+instance KnownAlgebra 'Product where
34+ algebraSing = SProduct
35+
36+
37+instance KnownAlgebra 'Sum where
38+ algebraSing = SSum
src/Rel8/Kind/Context.hs+8−41
@@ -1,13 +1,11 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2{-# language GADTs #-}
2{-# language GADTs #-}
3−{-# language LambdaCase #-}
4{-# language StandaloneKindSignatures #-}
3{-# language StandaloneKindSignatures #-}
4+{-# language TypeSynonymInstances #-}
5
5
6module Rel8.Kind.Context
6module Rel8.Kind.Context
7 ( Reifiable( contextSing )
7 ( Reifiable( contextSing )
8 , SContext(..)
8 , SContext(..)
9− , sReifiable
10− , sLabelable
11 )
9 )
12where
10where
13
11
@@ -18,13 +16,9 @@ import Prelude ()
18-- rel8
16-- rel8
19import Rel8.Aggregate ( Aggregate )
17import Rel8.Aggregate ( Aggregate )
20import Rel8.Expr ( Expr )
18import Rel8.Expr ( Expr )
21−import Rel8.Schema.Dict ( Dict( Dict ) )
19+import Rel8.Schema.Field ( Field )
22−import Rel8.Schema.Context ( Interpretation )
23−import Rel8.Schema.Context.Label ( Labelable )
24−import Rel8.Schema.Insert ( Insert )
25import Rel8.Schema.Kind ( Context )
20import Rel8.Schema.Kind ( Context )
26import Rel8.Schema.Name ( Name )
21import Rel8.Schema.Name ( Name )
27−import Rel8.Schema.Reify ( Reify )
28import Rel8.Schema.Result ( Result )
22import Rel8.Schema.Result ( Result )
29
23
30
24
@@ -32,14 +26,13 @@ type SContext :: Context -> Type
32data SContext context where
26data SContext context where
33 SAggregate :: SContext Aggregate
27 SAggregate :: SContext Aggregate
34 SExpr :: SContext Expr
28 SExpr :: SContext Expr
35− SInsert :: SContext Insert
29+ SField :: SContext (Field table)
36 SName :: SContext Name
30 SName :: SContext Name
37 SResult :: SContext Result
31 SResult :: SContext Result
38− SReify :: SContext context -> SContext (Reify context)
39
32
40
33
41type Reifiable :: Context -> Constraint
34type Reifiable :: Context -> Constraint
42−class Interpretation context => Reifiable context where
35+class Reifiable context where
43 contextSing :: SContext context
36 contextSing :: SContext context
44
37
45
38
@@ -51,39 +44,13 @@ instance Reifiable Expr where
51 contextSing = SExpr
44 contextSing = SExpr
52
45
53
46
54−instance Reifiable Result where
47+instance Reifiable (Field table) where
55− contextSing = SResult
48+ contextSing = SField
56
49
57
50
58−instance Reifiable Insert where
51+instance Reifiable Result where
59− contextSing = SInsert
52+ contextSing = SResult
60
53
61
54
62instance Reifiable Name where
55instance Reifiable Name where
63 contextSing = SName
56 contextSing = SName
64−
65−
66−instance Reifiable context => Reifiable (Reify context) where
67− contextSing = SReify contextSing
68−
69−
70−sReifiable :: SContext context -> Dict Reifiable context
71−sReifiable = \case
72− SAggregate -> Dict
73− SExpr -> Dict
74− SInsert -> Dict
75− SName -> Dict
76− SResult -> Dict
77− SReify context -> case sReifiable context of
78− Dict -> Dict
79−
80−
81−sLabelable :: SContext context -> Dict Labelable context
82−sLabelable = \case
83− SAggregate -> Dict
84− SExpr -> Dict
85− SInsert -> Dict
86− SName -> Dict
87− SResult -> Dict
88− SReify context -> case sLabelable context of
89− Dict -> Dict
src/Rel8/Kind/Labels.hsdeleted−61
@@ -1,61 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language FlexibleContexts #-}
3−{-# language FlexibleInstances #-}
4−{-# language GADTs #-}
5−{-# language LambdaCase #-}
6−{-# language StandaloneKindSignatures #-}
7−{-# language TypeOperators #-}
8−
9−module Rel8.Kind.Labels
10− ( Labels
11− , SLabels( SLabel, SLabels )
12− , KnownLabels( labelsSing )
13− , renderLabels
14− )
15−where
16−
17−-- base
18−import Data.Kind ( Constraint, Type )
19−import Data.List.NonEmpty ( NonEmpty( (:|) ), (<|) )
20−import Data.Proxy ( Proxy( Proxy ) )
21−import GHC.TypeLits ( KnownSymbol, Symbol, symbolVal )
22−import Prelude
23−
24−
25−type Labels :: Type
26−type Labels = [Symbol]
27−
28−
29−type SLabels :: Labels -> Type
30−data SLabels labels where
31− SLabel :: KnownSymbol label => Proxy label -> SLabels '[label]
32− SLabels :: KnownSymbol label => Proxy label -> SLabels labels -> SLabels (label ': labels)
33−
34−
35−type KnownLabels :: Labels -> Constraint
36−class KnownLabels labels where
37− labelsSing :: SLabels labels
38−
39−
40−instance KnownSymbol label => KnownLabels (label ': '[]) where
41− labelsSing = SLabel Proxy
42−
43−
44−instance (KnownSymbol label, KnownLabels (label_ ': labels)) =>
45− KnownLabels (label ': (label_ ': labels))
46− where
47− labelsSing = SLabels Proxy labelsSing
48−
49−
50−renderLabels :: SLabels labels -> NonEmpty String
51−renderLabels = cleanup . go
52− where
53− go :: SLabels labels -> NonEmpty String
54− go = \case
55− SLabel label -> pure (symbolVal label)
56− SLabels label labels -> symbolVal label <| go labels
57−
58− cleanup ("" :| []) = "anon" :| []
59− cleanup (a :| []) = a :| []
60− cleanup (a :| [""]) = a :| []
61− cleanup (a :| (b : c)) = a <| cleanup (b :| c)
src/Rel8/Kind/Necessity.hsdeleted−38
@@ -1,38 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language FlexibleContexts #-}
3−{-# language GADTs #-}
4−{-# language StandaloneKindSignatures #-}
5−
6−module Rel8.Kind.Necessity
7− ( Necessity( Optional, Required )
8− , SNecessity( SOptional, SRequired )
9− , KnownNecessity( necessitySing )
10− )
11−where
12−
13−-- base
14−import Data.Kind ( Constraint, Type )
15−import Prelude ()
16−
17−
18−type Necessity :: Type
19−data Necessity = Optional | Required
20−
21−
22−type SNecessity :: Necessity -> Type
23−data SNecessity necessity where
24− SOptional :: SNecessity 'Optional
25− SRequired :: SNecessity 'Required
26−
27−
28−type KnownNecessity :: Necessity -> Constraint
29−class KnownNecessity necessity where
30− necessitySing :: SNecessity necessity
31−
32−
33−instance KnownNecessity 'Optional where
34− necessitySing = SOptional
35−
36−
37−instance KnownNecessity 'Required where
38− necessitySing = SRequired
src/Rel8/Order.hs+2−9
@@ -4,7 +4,6 @@
4
4
5module Rel8.Order
5module Rel8.Order
6 ( Order(..)
6 ( Order(..)
7− , toOrderExprs
8 )
7 )
9where
8where
10
9
@@ -17,8 +16,7 @@ import Prelude
17import Data.Functor.Contravariant.Divisible ( Decidable, Divisible )
16import Data.Functor.Contravariant.Divisible ( Decidable, Divisible )
18
17
19-- opaleye
18-- opaleye
20−import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
19+import qualified Opaleye.Order as Opaleye
21−import qualified Opaleye.Internal.Order as Opaleye
22
20
23
21
24-- | An ordering expression for @a@. Primitive orderings are defined with
22-- | An ordering expression for @a@. Primitive orderings are defined with
@@ -26,12 +24,7 @@ import qualified Opaleye.Internal.Order as Opaleye
26-- instances.
24-- instances.
27--
25--
28-- A common pattern is to use '<>' to combine multiple orderings in sequence,
26-- A common pattern is to use '<>' to combine multiple orderings in sequence,
29−-- and '>$<' (from 'Contravariant') to select individual columns.
27+-- and 'Data.Functor.Contravariant.>$<' to select individual columns.
30type Order :: Type -> Type
28type Order :: Type -> Type
31newtype Order a = Order (Opaleye.Order a)
29newtype Order a = Order (Opaleye.Order a)
32 deriving newtype (Contravariant, Divisible, Decidable, Semigroup, Monoid)
30 deriving newtype (Contravariant, Divisible, Decidable, Semigroup, Monoid)
33−
34−
35−toOrderExprs :: Order a -> a -> [Opaleye.OrderExpr]
36−toOrderExprs (Order (Opaleye.Order order)) a =
37− uncurry Opaleye.OrderExpr <$> order a
src/Rel8/Query.hs+181−7
@@ -1,6 +1,6 @@
1−{-# language DerivingVia #-}
1+{-# language FlexibleContexts #-}
2−{-# language GeneralizedNewtypeDeriving #-}
3{-# language StandaloneKindSignatures #-}
2{-# language StandaloneKindSignatures #-}
3+{-# language UndecidableInstances #-}
4
4
5module Rel8.Query
5module Rel8.Query
6 ( Query( Query )
6 ( Query( Query )
@@ -8,37 +8,201 @@ module Rel8.Query
8where
8where
9
9
10-- base
10-- base
11+import Control.Applicative ( liftA2 )
12+import Control.Monad ( liftM2 )
11import Data.Kind ( Type )
13import Data.Kind ( Type )
14+import Data.Monoid ( Any( Any ) )
12import Prelude
15import Prelude
13
16
14-- opaleye
17-- opaleye
15−import qualified Opaleye.Select as Opaleye
18+import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
19+import qualified Opaleye.Internal.PackMap as Opaleye
20+import qualified Opaleye.Internal.PrimQuery as Opaleye hiding (lateral)
21+import qualified Opaleye.Internal.QueryArr as Opaleye
22+import qualified Opaleye.Internal.Tag as Opaleye
16
23
17-- rel8
24-- rel8
25+import Rel8.Expr ( Expr )
18import Rel8.Query.Set ( unionAll )
26import Rel8.Query.Set ( unionAll )
27+import Rel8.Query.Opaleye ( fromOpaleye )
19import Rel8.Query.Values ( values )
28import Rel8.Query.Values ( values )
29+import Rel8.Table ( Table, fromColumns, toColumns )
20import Rel8.Table.Alternative
30import Rel8.Table.Alternative
21 ( AltTable, (<|>:)
31 ( AltTable, (<|>:)
22 , AlternativeTable, emptyTable
32 , AlternativeTable, emptyTable
23 )
33 )
34+import Rel8.Table.Projection ( Projectable, apply, project )
24
35
25-- semigroupoids
36-- semigroupoids
26−import Data.Functor.Apply ( Apply, WrappedApplicative(..) )
37+import Data.Functor.Apply ( Apply, (<.>) )
27import Data.Functor.Bind ( Bind, (>>-) )
38import Data.Functor.Bind ( Bind, (>>-) )
28
39
29
40
30-- | The @Query@ monad allows you to compose a @SELECT@ query. This monad has
41-- | The @Query@ monad allows you to compose a @SELECT@ query. This monad has
31-- semantics similar to the list (@[]@) monad.
42-- semantics similar to the list (@[]@) monad.
32type Query :: Type -> Type
43type Query :: Type -> Type
33−newtype Query a = Query (Opaleye.Select a)
44+newtype Query a =
34− deriving newtype (Functor, Applicative, Monad)
45+ Query (
35− deriving Apply via (WrappedApplicative Opaleye.Select)
46+ -- This is based on Opaleye's Select monad, but with two addtions. We
47+ -- maintain a stack of PrimExprs from parent previous subselects. In
48+ -- practice, these are always the results of dummy calls to random().
49+ --
50+ -- We also return a Bool that indicates to the parent subselect whether
51+ -- or not that stack of PrimExprs were used at any point. If they weren't,
52+ -- then the call to random() is never added to the query.
53+ --
54+ -- This is all needed to implement evaluate. Consider the following code:
55+ --
56+ -- do
57+ -- x <- values [lit 'a', lit 'b', lit 'c']
58+ -- y <- evaluate $ nextval "user_id_seq"
59+ -- pure (x, y)
60+ --
61+ -- If we just used Opaleye's Select monad directly, the SQL would come out
62+ -- like this:
63+ --
64+ -- SELECT
65+ -- a, b
66+ -- FROM
67+ -- (VALUES ('a'), ('b'), ('c')) Q1(a),
68+ -- LATERAL (SELECT nextval('user_id_seq')) Q2(b);
69+ --
70+ -- From the Haskell code, you would intuitively expect to get back the
71+ -- results of three different calls to nextval(), but from Postgres' point
72+ -- of view, because the Q2 subquery doesn't reference anything from the Q1
73+ -- query, it thinks it only needs to call nextval() once. This is actually
74+ -- exactly the same problem you get with the deprecated ListT IO monad from
75+ -- the transformers package — *> behaves differently to >>=, so
76+ -- using ApplicativeDo can change the results of a program. ApplicativeDo
77+ -- is exactly the optimisation Postgres does on a "LATERAL" query that
78+ -- doesn't make any references to previous subselects.
79+ --
80+ -- Rel8's solution is generate the following SQL instead:
81+ --
82+ -- SELECT
83+ -- a, b
84+ -- FROM
85+ -- (SELECT
86+ -- random() AS dummy,
87+ -- *
88+ -- FROM
89+ -- (VALUES ('a'), ('b'), ('c')) Q1(a)) Q1,
90+ -- LATERAL (SELECT
91+ -- CASE
92+ -- WHEN dummy IS NOT NULL
93+ -- THEN nextval('user_id_seq')
94+ -- END) Q2(b);
95+ --
96+ -- We use random() here as the dummy value (and not some constant) because
97+ -- Postgres will again optimize if it sees that a value is constant
98+ -- (and thus only call nextval() once), but because random() is marked as
99+ -- VOLATILE, this inhibits Postgres from doing that optimisation.
100+ --
101+ -- Why not just reference the a column from the previous query directly
102+ -- instead of adding a dummy value? Basically, even if we extract out all
103+ -- the bindings introduced in a PrimQuery, we can't always be sure which
104+ -- ones refer to constant values, so if we end up laterally referencing a
105+ -- constant value, then all of this would be for nothing.
106+ --
107+ -- Why not just add the call to the previous subselect directly, like so:
108+ --
109+ -- SELECT
110+ -- a, b
111+ -- FROM
112+ -- (SELECT
113+ -- nextval('user_id_seq') AS eval,
114+ -- *
115+ -- FROM
116+ -- (VALUES ('a'), ('b'), ('c')) Q1(a)) Q1,
117+ -- LATERAL (SELECT eval) Q2(b);
118+ --
119+ -- That would work in this case. But consider the following Rel8 code:
120+ --
121+ -- do
122+ -- x <- values [lit 'a', lit 'b', lit 'c']
123+ -- y <- values [lit 'd', lit 'e', lit 'f']
124+ -- z <- evaluate $ nextval "user_id_seq"
125+ -- pure (x, y, z)
126+ --
127+ -- How many calls to nextval should there be? Our Haskell intuition says
128+ -- nine. But that's not what you would get if you used the above
129+ -- technique. The problem is, which VALUES query should the nextval be
130+ -- added to? You can choose one or the other to get three calls to
131+ -- nextval, but you still need to make a superfluous LATERAL references to
132+ -- the other if you want nine calls. So for the above Rel8 code we generate
133+ -- the following SQL:
134+ --
135+ -- SELECT
136+ -- a, b, c
137+ -- FROM
138+ -- (SELECT
139+ -- random() AS dummy,
140+ -- *
141+ -- FROM
142+ -- (VALUES ('a'), ('b'), ('c')) Q1(a)) Q1,
143+ -- (SELECT
144+ -- random() AS dummy,
145+ -- *
146+ -- FROM
147+ -- (VALUES ('d'), ('e'), ('f')) Q2(b)) Q2,
148+ -- LATERAL (SELECT
149+ -- CASE
150+ -- WHEN Q1.dummy IS NOT NULL AND Q2.dummy IS NOT NULL
151+ -- THEN nextval('user_id_seq')
152+ -- END) Q3(c);
153+ --
154+ -- This gives nine calls to nextval() as we would expect.
155+ [Opaleye.PrimExpr] -> Opaleye.Select (Any, a)
156+ )
157+
158+
159+instance Projectable Query where
160+ project f = fmap (fromColumns . apply f . toColumns)
161+
162+
163+instance Functor Query where
164+ fmap f (Query a) = Query (fmap (fmap (fmap f)) a)
165+
166+
167+instance Apply Query where
168+ (<.>) = (<*>)
169+
170+
171+instance Applicative Query where
172+ pure = fromOpaleye . pure
173+ liftA2 = liftM2
36
174
37
175
38instance Bind Query where
176instance Bind Query where
39 (>>-) = (>>=)
177 (>>-) = (>>=)
40
178
41
179
180+instance Monad Query where
181+ Query q >>= f = Query $ \dummies -> Opaleye.stateQueryArr $ \_ tag ->
182+ let
183+ qa = q dummies
184+ ((m, a), query, tag') = Opaleye.runStateQueryArr qa () tag
185+ Query q' = f a
186+ (dummies', query', tag'') =
187+ ( dummy : dummies
188+ , query <> Opaleye.aRebind bindings
189+ , Opaleye.next tag'
190+ )
191+ where
192+ (dummy, bindings) = Opaleye.run $ name random
193+ where
194+ random = Opaleye.FunExpr "random" []
195+ name = Opaleye.extractAttr "dummy" tag'
196+ qa' = Opaleye.lateral $ \_ -> q' dummies'
197+ ((m'@(Any needsDummies), b), query'', tag''') = Opaleye.runStateQueryArr qa' () tag''
198+ query'''
199+ | needsDummies = query' <> query''
200+ | otherwise = query <> query''
201+ m'' = m <> m'
202+ in
203+ ((m'', b), query''', tag''')
204+
205+
42-- | '<|>:' = 'unionAll'.
206-- | '<|>:' = 'unionAll'.
43instance AltTable Query where
207instance AltTable Query where
44 (<|>:) = unionAll
208 (<|>:) = unionAll
@@ -47,3 +211,13 @@ instance AltTable Query where
47-- | 'emptyTable' = 'values' @[]@.
211-- | 'emptyTable' = 'values' @[]@.
48instance AlternativeTable Query where
212instance AlternativeTable Query where
49 emptyTable = values []
213 emptyTable = values []
214+
215+
216+-- | '<>' = 'unionAll'.
217+instance Table Expr a => Semigroup (Query a) where
218+ (<>) = (<|>:)
219+
220+
221+-- | 'mempty' = @'values' []@.
222+instance Table Expr a => Monoid (Query a) where
223+ mempty = emptyTable
src/Rel8/Query.hs-boot+3−1
@@ -7,11 +7,13 @@ where
7
7
8-- base
8-- base
9import Data.Kind ( Type )
9import Data.Kind ( Type )
10+import Data.Monoid ( Any )
10import Prelude ()
11import Prelude ()
11
12
12-- opaleye
13-- opaleye
14+import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
13import qualified Opaleye.Select as Opaleye
15import qualified Opaleye.Select as Opaleye
14
16
15
17
16type Query :: Type -> Type
18type Query :: Type -> Type
17−newtype Query a = Query (Opaleye.Select a)
19+newtype Query a = Query ([Opaleye.PrimExpr] -> Opaleye.Select (Any, a))
src/Rel8/Query/Aggregate.hs+22−2
@@ -1,12 +1,17 @@
1{-# language FlexibleContexts #-}
1{-# language FlexibleContexts #-}
2+{-# language MonoLocalBinds #-}
3+{-# language ScopedTypeVariables #-}
4+{-# language TypeApplications #-}
2
5
3module Rel8.Query.Aggregate
6module Rel8.Query.Aggregate
4 ( aggregate
7 ( aggregate
5 , countRows
8 , countRows
9+ , mode
6 )
10 )
7where
11where
8
12
9-- base
13-- base
14+import Data.Functor.Contravariant ( (>$<) )
10import Data.Int ( Int64 )
15import Data.Int ( Int64 )
11import Prelude
16import Prelude
12
17
@@ -14,18 +19,25 @@ import Prelude
14import qualified Opaleye.Aggregate as Opaleye
19import qualified Opaleye.Aggregate as Opaleye
15
20
16-- rel8
21-- rel8
17−import Rel8.Aggregate ( Aggregate )
22+import Rel8.Aggregate ( Aggregates )
18import Rel8.Expr ( Expr )
23import Rel8.Expr ( Expr )
19import Rel8.Expr.Aggregate ( countStar )
24import Rel8.Expr.Aggregate ( countStar )
25+import Rel8.Expr.Order ( desc )
20import Rel8.Query ( Query )
26import Rel8.Query ( Query )
27+import Rel8.Query.Limit ( limit )
21import Rel8.Query.Maybe ( optional )
28import Rel8.Query.Maybe ( optional )
22import Rel8.Query.Opaleye ( mapOpaleye )
29import Rel8.Query.Opaleye ( mapOpaleye )
30+import Rel8.Query.Order ( orderBy )
31+import Rel8.Table ( toColumns )
32+import Rel8.Table.Aggregate ( hgroupBy )
33+import Rel8.Table.Cols ( Cols( Cols ), fromCols )
34+import Rel8.Table.Eq ( EqTable, eqTable )
23import Rel8.Table.Opaleye ( aggregator )
35import Rel8.Table.Opaleye ( aggregator )
24import Rel8.Table.Maybe ( maybeTable )
36import Rel8.Table.Maybe ( maybeTable )
25
37
26
38
27-- | Apply an aggregation to all rows returned by a 'Query'.
39-- | Apply an aggregation to all rows returned by a 'Query'.
28−aggregate :: Query (Aggregate exprs) -> Query exprs
40+aggregate :: Aggregates aggregates exprs => Query aggregates -> Query exprs
29aggregate = mapOpaleye (Opaleye.aggregate aggregator)
41aggregate = mapOpaleye (Opaleye.aggregate aggregator)
30
42
31
43
@@ -34,3 +46,11 @@ aggregate = mapOpaleye (Opaleye.aggregate aggregator)
34-- will return @0@.
46-- will return @0@.
35countRows :: Query a -> Query (Expr Int64)
47countRows :: Query a -> Query (Expr Int64)
36countRows = fmap (maybeTable 0 id) . optional . aggregate . fmap (const countStar)
48countRows = fmap (maybeTable 0 id) . optional . aggregate . fmap (const countStar)
49+
50+
51+-- | Return the most common row in a query.
52+mode :: forall a. EqTable a => Query a -> Query a
53+mode rows = limit 1 $ fmap (fromCols . snd) $ orderBy (fst >$< desc) $ do
54+ aggregate $ do
55+ row <- toColumns <$> rows
56+ pure (countStar, Cols $ hgroupBy (eqTable @a) row)
src/Rel8/Query/Distinct.hs+4−9
@@ -1,5 +1,3 @@
1−{-# options_ghc -fno-warn-redundant-constraints #-}
2−
3module Rel8.Query.Distinct
1module Rel8.Query.Distinct
4 ( distinct
2 ( distinct
5 , distinctOn
3 , distinctOn
@@ -8,12 +6,11 @@ module Rel8.Query.Distinct
8where
6where
9
7
10-- base
8-- base
11−import Prelude
9+import Prelude ()
12
10
13-- opaleye
11-- opaleye
14import qualified Opaleye.Distinct as Opaleye
12import qualified Opaleye.Distinct as Opaleye
15−import qualified Opaleye.Internal.Order as Opaleye
13+import qualified Opaleye.Order as Opaleye
16−import qualified Opaleye.Internal.QueryArr as Opaleye
17
14
18-- rel8
15-- rel8
19import Rel8.Order ( Order( Order ) )
16import Rel8.Order ( Order( Order ) )
@@ -33,13 +30,11 @@ distinct = mapOpaleye (Opaleye.distinctExplicit distinctspec)
33-- to a projection. If multiple rows have the same projection, it is
30-- to a projection. If multiple rows have the same projection, it is
34-- unspecified which row will be returned. If this matters, use 'distinctOnBy'.
31-- unspecified which row will be returned. If this matters, use 'distinctOnBy'.
35distinctOn :: EqTable b => (a -> b) -> Query a -> Query a
32distinctOn :: EqTable b => (a -> b) -> Query a -> Query a
36−distinctOn proj =
33+distinctOn proj = mapOpaleye (Opaleye.distinctOnExplicit unpackspec proj)
37− mapOpaleye (\q -> Opaleye.productQueryArr (Opaleye.distinctOn unpackspec proj . Opaleye.runSimpleQueryArr q))
38
34
39
35
40-- | Select all distinct rows from a query, where rows are equivalent according
36-- | Select all distinct rows from a query, where rows are equivalent according
41-- to a projection. If there are multiple rows with the same projection, the
37-- to a projection. If there are multiple rows with the same projection, the
42-- first row according to the specified 'Order' will be returned.
38-- first row according to the specified 'Order' will be returned.
43distinctOnBy :: EqTable b => (a -> b) -> Order a -> Query a -> Query a
39distinctOnBy :: EqTable b => (a -> b) -> Order a -> Query a -> Query a
44−distinctOnBy proj (Order order) =
40+distinctOnBy proj (Order order) = mapOpaleye (Opaleye.distinctOnByExplicit unpackspec proj order)
45− mapOpaleye (\q -> Opaleye.productQueryArr (Opaleye.distinctOnBy unpackspec proj order . Opaleye.runSimpleQueryArr q))
src/Rel8/Query/Each.hs+3−3
@@ -17,7 +17,7 @@ import Rel8.Query ( Query )
17import Rel8.Query.Opaleye ( fromOpaleye )
17import Rel8.Query.Opaleye ( fromOpaleye )
18import Rel8.Schema.Name ( Selects )
18import Rel8.Schema.Name ( Selects )
19import Rel8.Schema.Table ( TableSchema )
19import Rel8.Schema.Table ( TableSchema )
20−import Rel8.Table ( fromColumns, toColumns )
20+import Rel8.Table.Cols ( fromCols, toCols )
21import Rel8.Table.Opaleye ( table, unpackspec )
21import Rel8.Table.Opaleye ( table, unpackspec )
22
22
23
23
@@ -25,8 +25,8 @@ import Rel8.Table.Opaleye ( table, unpackspec )
25-- table@.
25-- table@.
26each :: Selects names exprs => TableSchema names -> Query exprs
26each :: Selects names exprs => TableSchema names -> Query exprs
27each =
27each =
28− fmap fromColumns .
28+ fmap fromCols .
29 fromOpaleye .
29 fromOpaleye .
30 Opaleye.selectTableExplicit unpackspec .
30 Opaleye.selectTableExplicit unpackspec .
31 table .
31 table .
32− fmap toColumns
32+ fmap toCols
src/Rel8/Query/Either.hs+27−17
@@ -3,23 +3,22 @@
3module Rel8.Query.Either
3module Rel8.Query.Either
4 ( keepLeftTable
4 ( keepLeftTable
5 , keepRightTable
5 , keepRightTable
6− , bindEitherTable
7 , bitraverseEitherTable
6 , bitraverseEitherTable
8 )
7 )
9where
8where
10
9
11-- base
10-- base
12−import Data.Functor ( (<&>) )
13import Prelude
11import Prelude
14
12
13+-- comonad
14+import Control.Comonad ( extract )
15+
15-- rel8
16-- rel8
16import Rel8.Expr ( Expr )
17import Rel8.Expr ( Expr )
17import Rel8.Expr.Eq ( (==.) )
18import Rel8.Expr.Eq ( (==.) )
18import Rel8.Query ( Query )
19import Rel8.Query ( Query )
19import Rel8.Query.Filter ( where_ )
20import Rel8.Query.Filter ( where_ )
20import Rel8.Query.Maybe ( optional )
21import Rel8.Query.Maybe ( optional )
21−import Rel8.Table ( Table )
22−import Rel8.Table.Bool ( bool )
23import Rel8.Table.Either
22import Rel8.Table.Either
24 ( EitherTable( EitherTable )
23 ( EitherTable( EitherTable )
25 , isLeftTable, isRightTable
24 , isLeftTable, isRightTable
@@ -27,30 +26,41 @@ import Rel8.Table.Either
27import Rel8.Table.Maybe ( MaybeTable( MaybeTable ), isJustTable )
26import Rel8.Table.Maybe ( MaybeTable( MaybeTable ), isJustTable )
28
27
29
28
30−keepLeftTable :: EitherTable a b -> Query a
29+-- | Filter 'EitherTable's, keeping only 'leftTable's.
30+keepLeftTable :: EitherTable Expr a b -> Query a
31keepLeftTable e@(EitherTable _ a _) = do
31keepLeftTable e@(EitherTable _ a _) = do
32 where_ $ isLeftTable e
32 where_ $ isLeftTable e
33− pure a
33+ pure (extract a)
34
34
35
35
36−keepRightTable :: EitherTable a b -> Query b
36+-- | Filter 'EitherTable's, keeping only 'rightTable's.
37+keepRightTable :: EitherTable Expr a b -> Query b
37keepRightTable e@(EitherTable _ _ b) = do
38keepRightTable e@(EitherTable _ _ b) = do
38 where_ $ isRightTable e
39 where_ $ isRightTable e
39− pure b
40+ pure (extract b)
40−
41−
42−bindEitherTable :: (Table Expr a, Functor m)
43− => (i -> m (EitherTable a b)) -> EitherTable a i -> m (EitherTable a b)
44−bindEitherTable query e@(EitherTable input a i) = do
45− query i <&> \(EitherTable output a' b) ->
46− EitherTable (input <> output) (bool a a' (isRightTable e)) b
47
41
48
42
43+-- | @bitraverseEitherTable f g x@ will pass all @leftTable@s through @f@ and
44+-- all @rightTable@s through @g@. The results are then lifted back into
45+-- @leftTable@ and @rightTable@, respectively. This is similar to 'bitraverse'
46+-- for 'Either'.
47+--
48+-- For example,
49+--
50+-- >>> :{
51+-- select do
52+-- x <- values (map lit [ Left True, Right (42 :: Int32) ])
53+-- bitraverseEitherTable (\y -> values [y, not_ y]) (\y -> pure (y * 100)) x
54+-- :}
55+-- [ Left True
56+-- , Left False
57+-- , Right 4200
58+-- ]
49bitraverseEitherTable :: ()
59bitraverseEitherTable :: ()
50 => (a -> Query c)
60 => (a -> Query c)
51 -> (b -> Query d)
61 -> (b -> Query d)
52− -> EitherTable a b
62+ -> EitherTable Expr a b
53− -> Query (EitherTable c d)
63+ -> Query (EitherTable Expr c d)
54bitraverseEitherTable f g e@(EitherTable tag _ _) = do
64bitraverseEitherTable f g e@(EitherTable tag _ _) = do
55 mc@(MaybeTable _ c) <- optional (f =<< keepLeftTable e)
65 mc@(MaybeTable _ c) <- optional (f =<< keepLeftTable e)
56 md@(MaybeTable _ d) <- optional (g =<< keepRightTable e)
66 md@(MaybeTable _ d) <- optional (g =<< keepRightTable e)
src/Rel8/Query/Evaluate.hsnew file+49
@@ -0,0 +1,49 @@
1+{-# language FlexibleContexts #-}
2+{-# language TupleSections #-}
3+
4+module Rel8.Query.Evaluate
5+ ( evaluate
6+ )
7+where
8+
9+-- base
10+import Control.Monad ( (>=>) )
11+import Data.Foldable ( foldl' )
12+import Data.List.NonEmpty ( NonEmpty( (:|) ), nonEmpty )
13+import Data.Monoid ( Any( Any ) )
14+import Prelude hiding ( undefined )
15+
16+-- opaleye
17+import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
18+
19+-- rel8
20+import Rel8.Expr ( Expr )
21+import Rel8.Expr.Bool ( (&&.) )
22+import Rel8.Expr.Opaleye ( fromPrimExpr )
23+import Rel8.Query ( Query( Query ) )
24+import Rel8.Query.Rebind ( rebind )
25+import Rel8.Table ( Table )
26+import Rel8.Table.Bool ( case_ )
27+import Rel8.Table.Undefined ( undefined )
28+
29+
30+-- | 'evaluate' takes expressions that could potentially have side effects and
31+-- \"runs\" them in the 'Query' monad. The returned expressions have no side
32+-- effects and can safely be reused.
33+evaluate :: Table Expr a => a -> Query a
34+evaluate = laterally >=> rebind "eval"
35+
36+
37+laterally :: Table Expr a => a -> Query a
38+laterally a = Query $ \bindings -> pure $ (Any True,) $
39+ case nonEmpty bindings of
40+ Nothing -> a
41+ Just bindings' -> case_ [(condition, a)] undefined
42+ where
43+ condition = foldl1' (&&.) (fmap go bindings')
44+ where
45+ go = fromPrimExpr . Opaleye.UnExpr Opaleye.OpIsNotNull
46+
47+
48+foldl1' :: (a -> a -> a) -> NonEmpty a -> a
49+foldl1' f (a :| as) = foldl' f a as
src/Rel8/Query/Exists.hs+15−17
@@ -2,8 +2,8 @@
2
2
3module Rel8.Query.Exists
3module Rel8.Query.Exists
4 ( exists, inQuery
4 ( exists, inQuery
5− , whereExists, with, withBy
5+ , present, with, withBy
6− , whereNotExists, without, withoutBy
6+ , absent, without, withoutBy
7 )
7 )
8where
8where
9
9
@@ -11,56 +11,54 @@ where
11import Prelude hiding ( filter )
11import Prelude hiding ( filter )
12
12
13-- opaleye
13-- opaleye
14+import qualified Opaleye.Exists as Opaleye
14import qualified Opaleye.Operators as Opaleye
15import qualified Opaleye.Operators as Opaleye
15
16
16-- rel8
17-- rel8
17import Rel8.Expr ( Expr )
18import Rel8.Expr ( Expr )
19+import Rel8.Expr.Opaleye ( fromColumn, fromPrimExpr )
18import Rel8.Query ( Query )
20import Rel8.Query ( Query )
19import Rel8.Query.Filter ( filter )
21import Rel8.Query.Filter ( filter )
20−import Rel8.Query.Maybe ( optional )
21import Rel8.Query.Opaleye ( mapOpaleye )
22import Rel8.Query.Opaleye ( mapOpaleye )
22import Rel8.Table.Eq ( EqTable, (==:) )
23import Rel8.Table.Eq ( EqTable, (==:) )
23−import Rel8.Table.Maybe ( isJustTable )
24
24
25
25
26-- | Checks if a query returns at least one row.
26-- | Checks if a query returns at least one row.
27exists :: Query a -> Query (Expr Bool)
27exists :: Query a -> Query (Expr Bool)
28−exists = fmap isJustTable . optional . whereExists
28+exists = fmap (fromPrimExpr . fromColumn) . mapOpaleye Opaleye.exists
29−-- FIXME: change this when b7aacc07c6392654cae439fc3b997620c3aa7a87 makes it
30−-- into a release of Opaleye
31
29
32
30
33inQuery :: EqTable a => a -> Query a -> Query (Expr Bool)
31inQuery :: EqTable a => a -> Query a -> Query (Expr Bool)
34inQuery a = exists . (>>= filter (a ==:))
32inQuery a = exists . (>>= filter (a ==:))
35
33
36
34
37−-- | Produce the empty query if the given query returns no rows. @whereExists@
35+-- | Produce the empty query if the given query returns no rows. @present@
38-- is equivalent to @WHERE EXISTS@ in SQL.
36-- is equivalent to @WHERE EXISTS@ in SQL.
39−whereExists :: Query a -> Query ()
37+present :: Query a -> Query ()
40−whereExists = mapOpaleye Opaleye.restrictExists
38+present = mapOpaleye Opaleye.restrictExists
41
39
42
40
43−-- | Produce the empty query if the given query returns rows. @whereNotExists@
41+-- | Produce the empty query if the given query returns rows. @absent@
44-- is equivalent to @WHERE NOT EXISTS@ in SQL.
42-- is equivalent to @WHERE NOT EXISTS@ in SQL.
45−whereNotExists :: Query a -> Query ()
43+absent :: Query a -> Query ()
46−whereNotExists = mapOpaleye Opaleye.restrictNotExists
44+absent = mapOpaleye Opaleye.restrictNotExists
47
45
48
46
49-- | @with@ is similar to 'filter', but allows the predicate to be a full query.
47-- | @with@ is similar to 'filter', but allows the predicate to be a full query.
50--
48--
51−-- @with f a = a <$ whereExists (f a)@, but this form matches 'filter'.
49+-- @with f a = a <$ present (f a)@, but this form matches 'filter'.
52with :: (a -> Query b) -> a -> Query a
50with :: (a -> Query b) -> a -> Query a
53−with f a = a <$ whereExists (f a)
51+with f a = a <$ present (f a)
54
52
55
53
56-- | Like @with@, but with a custom membership test.
54-- | Like @with@, but with a custom membership test.
57−withBy :: (a -> b -> Expr Bool) -> Query b -> a -> Query a
55+withBy :: (a -> b -> Expr Bool) -> Query b -> a -> Query a
58withBy predicate bs = with $ \a -> bs >>= filter (predicate a)
56withBy predicate bs = with $ \a -> bs >>= filter (predicate a)
59
57
60
58
61-- | Filter rows where @a -> Query b@ yields no rows.
59-- | Filter rows where @a -> Query b@ yields no rows.
62without :: (a -> Query b) -> a -> Query a
60without :: (a -> Query b) -> a -> Query a
63−without f a = a <$ whereNotExists (f a)
61+without f a = a <$ absent (f a)
64
62
65
63
66-- | Like @without@, but with a custom membership test.
64-- | Like @without@, but with a custom membership test.
src/Rel8/Query/Indexed.hsnew file+21
@@ -0,0 +1,21 @@
1+module Rel8.Query.Indexed
2+ ( indexed
3+ )
4+where
5+
6+-- base
7+import Control.Applicative ( liftA2 )
8+import Data.Int ( Int64 )
9+import Prelude
10+
11+-- rel8
12+import Rel8.Expr ( Expr )
13+import Rel8.Expr.Window ( rowNumber )
14+import Rel8.Query ( Query )
15+import Rel8.Query.Window ( window )
16+import Rel8.Table.Window ( currentRow )
17+
18+
19+-- | Pair each row of a query with its index within the query.
20+indexed :: Query a -> Query (Expr Int64, a)
21+indexed = window (liftA2 (,) (subtract 1 <$> rowNumber) currentRow)
src/Rel8/Query/List.hs+93−14
@@ -1,23 +1,58 @@
1{-# language FlexibleContexts #-}
1{-# language FlexibleContexts #-}
2+{-# language GADTs #-}
3+{-# language NamedFieldPuns #-}
2
4
3module Rel8.Query.List
5module Rel8.Query.List
4 ( many, some
6 ( many, some
7+ , manyExpr, someExpr
8+ , catListTable, catNonEmptyTable
9+ , catList, catNonEmpty
5 )
10 )
6where
11where
7
12
8-- base
13-- base
14+import Data.Functor.Identity ( runIdentity )
15+import Data.List.NonEmpty ( NonEmpty )
9import Prelude
16import Prelude
10
17
18+-- opaleye
19+import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
20+
11-- rel8
21-- rel8
12import Rel8.Expr ( Expr )
22import Rel8.Expr ( Expr )
23+import Rel8.Expr.Aggregate ( listAggExpr, nonEmptyAggExpr )
24+import Rel8.Expr.Opaleye ( mapPrimExpr )
13import Rel8.Query ( Query )
25import Rel8.Query ( Query )
14import Rel8.Query.Aggregate ( aggregate )
26import Rel8.Query.Aggregate ( aggregate )
15import Rel8.Query.Maybe ( optional )
27import Rel8.Query.Maybe ( optional )
16−import Rel8.Table ( Table )
28+import Rel8.Query.Rebind ( rebind )
29+import Rel8.Schema.HTable.Vectorize ( hunvectorize )
30+import Rel8.Schema.Null ( Sql, Unnullify )
31+import Rel8.Schema.Spec ( Spec( Spec, info ) )
32+import Rel8.Table ( Table, fromColumns )
33+import Rel8.Table.Cols ( toCols )
17import Rel8.Table.Aggregate ( listAgg, nonEmptyAgg )
34import Rel8.Table.Aggregate ( listAgg, nonEmptyAgg )
18−import Rel8.Table.List ( ListTable )
35+import Rel8.Table.List ( ListTable( ListTable ) )
19import Rel8.Table.Maybe ( maybeTable )
36import Rel8.Table.Maybe ( maybeTable )
20−import Rel8.Table.NonEmpty ( NonEmptyTable )
37+import Rel8.Table.NonEmpty ( NonEmptyTable( NonEmptyTable ) )
38+import Rel8.Type ( DBType, typeInformation )
39+import Rel8.Type.Array ( extractArrayElement )
40+import Rel8.Type.Information ( TypeInformation )
41+
42+
43+-- | Aggregate a 'Query' into a 'ListTable'. If the supplied query returns 0
44+-- rows, this function will produce a 'Query' that returns one row containing
45+-- the empty @ListTable@. If the supplied @Query@ does return rows, @many@ will
46+-- return exactly one row, with a @ListTable@ collecting all returned rows.
47+--
48+-- @many@ is analogous to 'Control.Applicative.many' from
49+-- @Control.Applicative@.
50+many :: Table Expr a => Query a -> Query (ListTable Expr a)
51+many =
52+ fmap (maybeTable mempty (\(ListTable a) -> ListTable a)) .
53+ optional .
54+ aggregate .
55+ fmap (listAgg . toCols)
21
56
22
57
23-- | Aggregate a 'Query' into a 'NonEmptyTable'. If the supplied query returns
58-- | Aggregate a 'Query' into a 'NonEmptyTable'. If the supplied query returns
@@ -28,16 +63,60 @@ import Rel8.Table.NonEmpty ( NonEmptyTable )
28--
63--
29-- @some@ is analogous to 'Control.Applicative.some' from
64-- @some@ is analogous to 'Control.Applicative.some' from
30-- @Control.Applicative@.
65-- @Control.Applicative@.
31−some :: Table Expr a => Query a -> Query (NonEmptyTable a)
66+some :: Table Expr a => Query a -> Query (NonEmptyTable Expr a)
32−some = aggregate . fmap nonEmptyAgg
67+some =
68+ fmap (\(NonEmptyTable a) -> NonEmptyTable a) .
69+ aggregate .
70+ fmap (nonEmptyAgg . toCols)
33
71
34
72
35−-- | Aggregate a 'Query' into a 'ListTable'. If the supplied query returns 0
73+-- | A version of 'many' specialised to single expressions.
36−-- rows, this function will produce a 'Query' that returns one row containing
74+manyExpr :: Sql DBType a => Query (Expr a) -> Query (Expr [a])
37−-- the empty @ListTable@. If the supplied @Query@ does return rows, @many@ will
75+manyExpr = fmap (maybeTable mempty id) . optional . aggregate . fmap listAggExpr
38−-- return exactly one row, with a @ListTable@ collecting all returned rows.
76+
39−--
77+
40−-- @many@ is analogous to 'Control.Applicative.many' from
78+-- | A version of 'many' specialised to single expressions.
41−-- @Control.Applicative@.
79+someExpr :: Sql DBType a => Query (Expr a) -> Query (Expr (NonEmpty a))
42−many :: Table Expr a => Query a -> Query (ListTable a)
80+someExpr = aggregate . fmap nonEmptyAggExpr
43−many = fmap (maybeTable mempty id) . optional . aggregate . fmap listAgg
81+
82+
83+-- | Expand a 'ListTable' into a 'Query', where each row in the query is an
84+-- element of the given @ListTable@.
85+--
86+-- @catListTable@ is an inverse to 'many'.
87+catListTable :: Table Expr a => ListTable Expr a -> Query a
88+catListTable (ListTable as) =
89+ rebind "unnest" $ fromColumns $ runIdentity $
90+ hunvectorize (\Spec {info} -> pure . sunnest info) as
91+
92+
93+-- | Expand a 'NonEmptyTable' into a 'Query', where each row in the query is an
94+-- element of the given @NonEmptyTable@.
95+--
96+-- @catNonEmptyTable@ is an inverse to 'some'.
97+catNonEmptyTable :: Table Expr a => NonEmptyTable Expr a -> Query a
98+catNonEmptyTable (NonEmptyTable as) =
99+ rebind "unnest" $ fromColumns $ runIdentity $
100+ hunvectorize (\Spec {info} -> pure . sunnest info) as
101+
102+
103+-- | Expand an expression that contains a list into a 'Query', where each row
104+-- in the query is an element of the given list.
105+--
106+-- @catList@ is an inverse to 'manyExpr'.
107+catList :: Sql DBType a => Expr [a] -> Query (Expr a)
108+catList = rebind "unnest" . sunnest typeInformation
109+
110+
111+-- | Expand an expression that contains a non-empty list into a 'Query', where
112+-- each row in the query is an element of the given list.
113+--
114+-- @catNonEmpty@ is an inverse to 'someExpr'.
115+catNonEmpty :: Sql DBType a => Expr (NonEmpty a) -> Query (Expr a)
116+catNonEmpty = rebind "unnest" . sunnest typeInformation
117+
118+
119+sunnest :: TypeInformation (Unnullify a) -> Expr (list a) -> Expr a
120+sunnest info = mapPrimExpr $
121+ extractArrayElement info .
122+ Opaleye.UnExpr (Opaleye.UnOpOther "UNNEST")
src/Rel8/Query/Maybe.hs+26−45
@@ -1,7 +1,10 @@
1+{-# language GADTs #-}
2+{-# language LambdaCase #-}
3+{-# language NamedFieldPuns #-}
4+
1module Rel8.Query.Maybe
5module Rel8.Query.Maybe
2 ( optional
6 ( optional
3 , catMaybeTable
7 , catMaybeTable
4− , bindMaybeTable
5 , traverseMaybeTable
8 , traverseMaybeTable
6 )
9 )
7where
10where
@@ -9,23 +12,20 @@ where
9-- base
12-- base
10import Prelude
13import Prelude
11
14
15+-- comonad
16+import Control.Comonad ( extract )
17+
12-- opaleye
18-- opaleye
13−import qualified Opaleye.Internal.PackMap as Opaleye
19+import qualified Opaleye.Internal.MaybeFields as Opaleye
14−import qualified Opaleye.Internal.PrimQuery as Opaleye
15−import qualified Opaleye.Internal.QueryArr as Opaleye
16−import qualified Opaleye.Internal.Tag as Opaleye
17−import qualified Opaleye.Internal.Unpackspec as Opaleye
18
20
19-- rel8
21-- rel8
20−import Rel8.Expr.Bool ( true )
22+import Rel8.Expr ( Expr )
21import Rel8.Expr.Eq ( (==.) )
23import Rel8.Expr.Eq ( (==.) )
22−import Rel8.Expr.Opaleye ( toPrimExpr )
24+import Rel8.Expr.Opaleye ( fromColumn, fromPrimExpr )
23import Rel8.Query ( Query )
25import Rel8.Query ( Query )
24import Rel8.Query.Filter ( where_ )
26import Rel8.Query.Filter ( where_ )
25import Rel8.Query.Opaleye ( mapOpaleye )
27import Rel8.Query.Opaleye ( mapOpaleye )
26−import Rel8.Table.Maybe ( MaybeTable( MaybeTable ), isJustTable )
28+import Rel8.Table.Maybe ( MaybeTable(..), isJustTable )
27−import Rel8.Table.Opaleye ( unpackspec )
28−import Rel8.Table.Tag ( Tag(..), fromExpr )
29
29
30
30
31-- | Convert a query that might return zero rows to a query that always returns
31-- | Convert a query that might return zero rows to a query that always returns
@@ -33,18 +33,11 @@ import Rel8.Table.Tag ( Tag(..), fromExpr )
33--
33--
34-- To speak in more concrete terms, 'optional' is most useful to write @LEFT
34-- To speak in more concrete terms, 'optional' is most useful to write @LEFT
35-- JOIN@s.
35-- JOIN@s.
36−optional :: Query a -> Query (MaybeTable a)
36+optional :: Query a -> Query (MaybeTable Expr a)
37−optional = mapOpaleye $ Opaleye.QueryArr . go
37+optional = mapOpaleye $ Opaleye.optionalInternal $ \tag a -> MaybeTable
38− where
38+ { tag = fromPrimExpr $ fromColumn tag
39− go query (i, left, tag) =
39+ , just = pure a
40− (MaybeTable (fromExpr t') a, join, Opaleye.next tag')
40+ }
41− where
42− (MaybeTable Tag {expr = t} a, right, tag') =
43− Opaleye.runSimpleQueryArr (pure <$> query) (i, tag)
44− (t', bindings) = Opaleye.run $
45− Opaleye.runUnpackspec unpackspec (Opaleye.extractAttr "maybe" tag') t
46− join = Opaleye.Join Opaleye.LeftJoin condition [] bindings left right
47− condition = toPrimExpr true
48
41
49
42
50-- | Filter out 'MaybeTable's, returning only the tables that are not-null.
43-- | Filter out 'MaybeTable's, returning only the tables that are not-null.
@@ -52,36 +45,24 @@ optional = mapOpaleye $ Opaleye.QueryArr . go
52-- This operation can be used to "undo" the effect of 'optional', which
45-- This operation can be used to "undo" the effect of 'optional', which
53-- operationally is like turning a @LEFT JOIN@ back into a full @JOIN@. You
46-- operationally is like turning a @LEFT JOIN@ back into a full @JOIN@. You
54-- can think of this as analogous to 'Data.Maybe.catMaybes'.
47-- can think of this as analogous to 'Data.Maybe.catMaybes'.
55−catMaybeTable :: MaybeTable a -> Query a
48+catMaybeTable :: MaybeTable Expr a -> Query a
56catMaybeTable ma@(MaybeTable _ a) = do
49catMaybeTable ma@(MaybeTable _ a) = do
57 where_ $ isJustTable ma
50 where_ $ isJustTable ma
58− pure a
51+ pure (extract a)
59−
60−
61−-- | @bindMaybeTable f x@ is similar to the monadic bind (@>>=@) operation. It
62−-- allows you to "extend" an optional query with another query. If either the
63−-- input or output are 'Rel8.nothingTable', then the result is
64−-- 'Rel8.nothingTable'.
65−--
66−-- This is similar to 'traverseMaybeTable', followed by a @join@ on the
67−-- resulting @MaybeTable@s.
68−bindMaybeTable :: Monad m
69− => (a -> m (MaybeTable b)) -> MaybeTable a -> m (MaybeTable b)
70−bindMaybeTable query (MaybeTable input a) = do
71− MaybeTable output b <- query a
72− pure $ MaybeTable (input <> output) b
73
52
74
53
75-- | Extend an optional query with another query. This is useful if you want
54-- | Extend an optional query with another query. This is useful if you want
76-- to step through multiple @LEFT JOINs@.
55-- to step through multiple @LEFT JOINs@.
77--
56--
78-- Note that @traverseMaybeTable@ takes a @a -> Query b@ function, which means
57-- Note that @traverseMaybeTable@ takes a @a -> Query b@ function, which means
79−-- you also have the ability to "expand" one row into multiple rows. If the
58+-- you also have the ability to "expand" one row into multiple rows. If the
80-- @a -> Query b@ function returns no rows, then the resulting query will also
59-- @a -> Query b@ function returns no rows, then the resulting query will also
81-- have no rows. However, regardless of the given @a -> Query b@ function, if
60-- have no rows. However, regardless of the given @a -> Query b@ function, if
82−-- the input is @noTable@, you will always get exactly one @noTable@ back.
61+-- the input is @nothingTable@, you will always get exactly one @nothingTable@
83−traverseMaybeTable :: (a -> Query b) -> MaybeTable a -> Query (MaybeTable b)
62+-- back.
63+traverseMaybeTable :: (a -> Query b) -> MaybeTable Expr a -> Query (MaybeTable Expr b)
84traverseMaybeTable query ma@(MaybeTable input _) = do
64traverseMaybeTable query ma@(MaybeTable input _) = do
85− MaybeTable output b <- optional (query =<< catMaybeTable ma)
65+ optional (query =<< catMaybeTable ma) >>= \case
86− where_ $ expr output ==. expr input
66+ MaybeTable output b -> do
87− pure $ MaybeTable input b
67+ where_ $ output ==. input
68+ pure $ MaybeTable input b
src/Rel8/Query/Null.hs+15
@@ -1,5 +1,8 @@
1+{-# language FlexibleContexts #-}
2+
1module Rel8.Query.Null
3module Rel8.Query.Null
2 ( catNull
4 ( catNull
5+ , catNullTable
3 )
6 )
4where
7where
5
8
@@ -9,6 +12,8 @@ import Prelude
9-- rel8
12-- rel8
10import Rel8.Expr ( Expr )
13import Rel8.Expr ( Expr )
11import Rel8.Expr.Null ( isNonNull, unsafeUnnullify )
14import Rel8.Expr.Null ( isNonNull, unsafeUnnullify )
15+import Rel8.Table ( Table )
16+import Rel8.Table.Null ( NullTable, isNonNullTable, unsafeUnnullifyTable )
12import Rel8.Query ( Query )
17import Rel8.Query ( Query )
13import Rel8.Query.Filter ( where_ )
18import Rel8.Query.Filter ( where_ )
14
19
@@ -21,3 +26,13 @@ catNull :: Expr (Maybe a) -> Query (Expr a)
21catNull a = do
26catNull a = do
22 where_ $ isNonNull a
27 where_ $ isNonNull a
23 pure $ unsafeUnnullify a
28 pure $ unsafeUnnullify a
29+
30+
31+-- | Filter a 'Query' that might return @nullTable@ to a 'Query' without any
32+-- @nullTable@s.
33+--
34+-- Corresponds to 'Data.Maybe.catMaybes'.
35+catNullTable :: Table Expr a => NullTable Expr a -> Query a
36+catNullTable a = do
37+ where_ $ isNonNullTable a
38+ pure $ unsafeUnnullifyTable a
src/Rel8/Query/Opaleye.hs+41−5
@@ -1,34 +1,70 @@
1+{-# language TupleSections #-}
2+
1module Rel8.Query.Opaleye
3module Rel8.Query.Opaleye
2 ( fromOpaleye
4 ( fromOpaleye
3 , toOpaleye
5 , toOpaleye
4 , mapOpaleye
6 , mapOpaleye
5 , zipOpaleyeWith
7 , zipOpaleyeWith
8+ , unsafePeekQuery
6 )
9 )
7where
10where
8
11
9-- base
12-- base
13+import Control.Applicative ( liftA2 )
10import Prelude
14import Prelude
11
15
12-- opaleye
16-- opaleye
13−import qualified Opaleye.Select as Opaleye
17+import qualified Opaleye.Internal.QueryArr as Opaleye
18+import qualified Opaleye.Internal.Tag as Opaleye
14
19
15-- rel8
20-- rel8
16import {-# SOURCE #-} Rel8.Query ( Query( Query ) )
21import {-# SOURCE #-} Rel8.Query ( Query( Query ) )
17
22
18
23
19fromOpaleye :: Opaleye.Select a -> Query a
24fromOpaleye :: Opaleye.Select a -> Query a
20−fromOpaleye = Query
25+fromOpaleye = Query . pure . fmap pure
21
26
22
27
23toOpaleye :: Query a -> Opaleye.Select a
28toOpaleye :: Query a -> Opaleye.Select a
24−toOpaleye (Query a) = a
29+toOpaleye (Query a) = snd <$> a mempty
25
30
26
31
27mapOpaleye :: (Opaleye.Select a -> Opaleye.Select b) -> Query a -> Query b
32mapOpaleye :: (Opaleye.Select a -> Opaleye.Select b) -> Query a -> Query b
28−mapOpaleye f = fromOpaleye . f . toOpaleye
33+mapOpaleye f (Query a) = Query (fmap (mapping f) a)
29
34
30
35
31zipOpaleyeWith :: ()
36zipOpaleyeWith :: ()
32 => (Opaleye.Select a -> Opaleye.Select b -> Opaleye.Select c)
37 => (Opaleye.Select a -> Opaleye.Select b -> Opaleye.Select c)
33 -> Query a -> Query b -> Query c
38 -> Query a -> Query b -> Query c
34−zipOpaleyeWith f a b = fromOpaleye $ f (toOpaleye a) (toOpaleye b)
39+zipOpaleyeWith f (Query a) (Query b) = Query $ liftA2 (zipping f) a b
40+
41+
42+unsafePeekQuery :: Query a -> a
43+unsafePeekQuery (Query q) = case q mempty of
44+ f -> case Opaleye.runStateQueryArr f () Opaleye.start of
45+ ((_, a), _, _) -> a
46+
47+
48+mapping :: ()
49+ => (Opaleye.Select a -> Opaleye.Select b)
50+ -> Opaleye.Select (m, a) -> Opaleye.Select (m, b)
51+mapping f q = Opaleye.stateQueryArr $ \_ tag ->
52+ let
53+ ((m, _), _, _) = Opaleye.runStateQueryArr q () tag
54+ q' = (m,) <$> f (snd <$> q)
55+ in
56+ Opaleye.runStateQueryArr q' () tag
57+
58+
59+zipping :: Semigroup m
60+ => (Opaleye.Select a -> Opaleye.Select b -> Opaleye.Select c)
61+ -> Opaleye.Select (m, a) -> Opaleye.Select (m, b) -> Opaleye.Select (m, c)
62+zipping f q q' =
63+ Opaleye.stateQueryArr $ \_ tag ->
64+ let
65+ ((m, _), _, _) = Opaleye.runStateQueryArr q () tag
66+ ((m', _), _, _) = Opaleye.runStateQueryArr q' () tag
67+ m'' = m <> m'
68+ q'' = (m'',) <$> f (snd <$> q) (snd <$> q')
69+ in
70+ Opaleye.runStateQueryArr q'' () tag
src/Rel8/Query/Rebind.hsnew file+27
@@ -0,0 +1,27 @@
1+{-# language FlexibleContexts #-}
2+
3+module Rel8.Query.Rebind
4+ ( rebind
5+ )
6+where
7+
8+-- base
9+import Prelude
10+import Control.Arrow ((<<<))
11+
12+-- opaleye
13+import qualified Opaleye.Internal.Rebind as Opaleye
14+
15+-- rel8
16+import Rel8.Expr ( Expr )
17+import Rel8.Query ( Query )
18+import Rel8.Table ( Table )
19+import Rel8.Table.Opaleye ( unpackspec )
20+import Rel8.Query.Opaleye (fromOpaleye)
21+
22+
23+-- | 'rebind' takes a variable name, some expressions, and binds each of them
24+-- to a new variable in the SQL. The @a@ returned consists only of these
25+-- variables. It's essentially a @let@ binding for Postgres expressions.
26+rebind :: Table Expr a => String -> a -> Query a
27+rebind prefix a = fromOpaleye (Opaleye.rebindExplicitPrefix prefix unpackspec <<< pure a)
src/Rel8/Query/SQL.hs+6−59
@@ -1,74 +1,21 @@
1{-# language FlexibleContexts #-}
1{-# language FlexibleContexts #-}
2−{-# language TypeFamilies #-}
2+{-# language MonoLocalBinds #-}
3−{-# language ViewPatterns #-}
4
3
5module Rel8.Query.SQL
4module Rel8.Query.SQL
6 ( showQuery
5 ( showQuery
7− , sqlForQuery, sqlForQueryWithNames
8 )
6 )
9where
7where
10
8
11-- base
9-- base
12−import Data.Foldable ( fold )
13−import Data.Functor.Const ( Const( Const ), getConst )
14−import Data.Void ( Void )
15import Prelude
10import Prelude
16
11
17−-- opaleye
18−import qualified Opaleye.Internal.HaskellDB.Sql as Opaleye
19−import qualified Opaleye.Internal.PrimQuery as Opaleye
20−import qualified Opaleye.Internal.Print as Opaleye
21−import qualified Opaleye.Internal.Optimize as Opaleye
22−import qualified Opaleye.Internal.QueryArr as Opaleye hiding ( Select )
23−import qualified Opaleye.Internal.Sql as Opaleye
24−
25-- rel8
12-- rel8
26−import Rel8.Expr ( Expr, Col(..) )
13+import Rel8.Expr ( Expr )
27−import Rel8.Expr.Opaleye ( toPrimExpr )
28import Rel8.Query ( Query )
14import Rel8.Query ( Query )
29−import Rel8.Query.Opaleye ( toOpaleye )
15+import Rel8.Statement.Select ( ppSelect )
30−import Rel8.Schema.Name ( Selects, Col(..) )
16+import Rel8.Table ( Table )
31−import Rel8.Schema.HTable ( htabulateA, hfield )
32−import Rel8.Table ( Table, toColumns )
33−import Rel8.Table.Name ( namesFromLabels )
34−import Rel8.Table.Opaleye ( castTable )
35
17
36
18
37−-- | Convert a query to a 'String' containing the query as a @SELECT@
19+-- | Convert a 'Query' to a 'String' containing a @SELECT@ statement.
38−-- statement.
39showQuery :: Table Expr a => Query a -> String
20showQuery :: Table Expr a => Query a -> String
40−showQuery = fold . sqlForQuery
21+showQuery = show . ppSelect
41−
42−
43−sqlForQuery :: Table Expr a
44− => Query a -> Maybe String
45−sqlForQuery = sqlForQueryWithNames namesFromLabels . fmap toColumns
46−
47−
48−sqlForQueryWithNames :: Selects names exprs
49− => names -> Query exprs -> Maybe String
50−sqlForQueryWithNames names query =
51− show . Opaleye.ppSql . selectFrom names exprs <$> optimize primQuery
52− where
53− (exprs, primQuery, _) =
54− Opaleye.runSimpleQueryArrStart (toOpaleye query) ()
55−
56−
57−optimize :: Opaleye.PrimQuery' a -> Maybe (Opaleye.PrimQuery' Void)
58−optimize = Opaleye.removeEmpty . Opaleye.optimize
59−
60−
61−selectFrom :: Selects names exprs
62− => names -> exprs -> Opaleye.PrimQuery' Void -> Opaleye.Select
63−selectFrom (toColumns -> names) (toColumns . castTable -> exprs) query =
64− Opaleye.SelectFrom $ Opaleye.newSelect
65− { Opaleye.attrs = Opaleye.SelectAttrs attributes
66− , Opaleye.tables = Opaleye.oneTable select
67− }
68− where
69− select = Opaleye.foldPrimQuery Opaleye.sqlQueryGenerator query
70− attributes = getConst $ htabulateA $ \field -> case hfield names field of
71− NameCol name -> case hfield exprs field of
72− DB (toPrimExpr -> expr) -> Const (pure (makeAttr name expr))
73− makeAttr label expr =
74− (Opaleye.sqlExpr expr, Just (Opaleye.SqlColumn label))
src/Rel8/Query/Set.hs+6−6
@@ -23,36 +23,36 @@ import Rel8.Table.Opaleye ( binaryspec )
23
23
24
24
25-- | Combine the results of two queries of the same type, collapsing
25-- | Combine the results of two queries of the same type, collapsing
26−-- duplicates. @union a b@ is the same as the SQL statement @x UNION b@.
26+-- duplicates. @union a b@ is the same as the SQL statement @a UNION b@.
27union :: EqTable a => Query a -> Query a -> Query a
27union :: EqTable a => Query a -> Query a -> Query a
28union = zipOpaleyeWith (Opaleye.unionExplicit binaryspec)
28union = zipOpaleyeWith (Opaleye.unionExplicit binaryspec)
29
29
30
30
31-- | Combine the results of two queries of the same type, retaining duplicates.
31-- | Combine the results of two queries of the same type, retaining duplicates.
32−-- @unionAll a b@ is the same as the SQL statement @x UNION ALL b@.
32+-- @unionAll a b@ is the same as the SQL statement @a UNION ALL b@.
33unionAll :: Table Expr a => Query a -> Query a -> Query a
33unionAll :: Table Expr a => Query a -> Query a -> Query a
34unionAll = zipOpaleyeWith (Opaleye.unionAllExplicit binaryspec)
34unionAll = zipOpaleyeWith (Opaleye.unionAllExplicit binaryspec)
35
35
36
36
37-- | Find the intersection of two queries, collapsing duplicates. @intersect a
37-- | Find the intersection of two queries, collapsing duplicates. @intersect a
38−-- b@ is the same as the SQL statement @x INTERSECT b@.
38+-- b@ is the same as the SQL statement @a INTERSECT b@.
39intersect :: EqTable a => Query a -> Query a -> Query a
39intersect :: EqTable a => Query a -> Query a -> Query a
40intersect = zipOpaleyeWith (Opaleye.intersectExplicit binaryspec)
40intersect = zipOpaleyeWith (Opaleye.intersectExplicit binaryspec)
41
41
42
42
43-- | Find the intersection of two queries, retaining duplicates. @intersectAll
43-- | Find the intersection of two queries, retaining duplicates. @intersectAll
44−-- a b@ is the same as the SQL statement @x INTERSECT ALL b@.
44+-- a b@ is the same as the SQL statement @a INTERSECT ALL b@.
45intersectAll :: EqTable a => Query a -> Query a -> Query a
45intersectAll :: EqTable a => Query a -> Query a -> Query a
46intersectAll = zipOpaleyeWith (Opaleye.intersectAllExplicit binaryspec)
46intersectAll = zipOpaleyeWith (Opaleye.intersectAllExplicit binaryspec)
47
47
48
48
49-- | Find the difference of two queries, collapsing duplicates @except a b@ is
49-- | Find the difference of two queries, collapsing duplicates @except a b@ is
50−-- the same as the SQL statement @x INTERSECT b@.
50+-- the same as the SQL statement @a EXCEPT b@.
51except :: EqTable a => Query a -> Query a -> Query a
51except :: EqTable a => Query a -> Query a -> Query a
52except = zipOpaleyeWith (Opaleye.exceptExplicit binaryspec)
52except = zipOpaleyeWith (Opaleye.exceptExplicit binaryspec)
53
53
54
54
55-- | Find the difference of two queries, retaining duplicates. @exceptAll a b@
55-- | Find the difference of two queries, retaining duplicates. @exceptAll a b@
56−-- is the same as the SQL statement @x EXCEPT ALL b@.
56+-- is the same as the SQL statement @a EXCEPT ALL b@.
57exceptAll :: EqTable a => Query a -> Query a -> Query a
57exceptAll :: EqTable a => Query a -> Query a -> Query a
58exceptAll = zipOpaleyeWith (Opaleye.exceptAllExplicit binaryspec)
58exceptAll = zipOpaleyeWith (Opaleye.exceptAllExplicit binaryspec)
src/Rel8/Query/These.hs+52−45
@@ -1,4 +1,5 @@
1{-# language FlexibleContexts #-}
1{-# language FlexibleContexts #-}
2+{-# language GADTs #-}
2
3
3module Rel8.Query.These
4module Rel8.Query.These
4 ( alignBy
5 ( alignBy
@@ -7,7 +8,6 @@ module Rel8.Query.These
7 , keepThisTable, loseThisTable
8 , keepThisTable, loseThisTable
8 , keepThatTable, loseThatTable
9 , keepThatTable, loseThatTable
9 , keepThoseTable, loseThoseTable
10 , keepThoseTable, loseThoseTable
10− , bindTheseTable
11 , bitraverseTheseTable
11 , bitraverseTheseTable
12 )
12 )
13where
13where
@@ -15,27 +15,29 @@ where
15-- base
15-- base
16import Prelude
16import Prelude
17
17
18+-- comonad
19+import Control.Comonad ( extract )
20+
18-- opaleye
21-- opaleye
19−import qualified Opaleye.Internal.Join as Opaleye
22+import qualified Opaleye.Internal.PackMap as Opaleye
20import qualified Opaleye.Internal.PrimQuery as Opaleye
23import qualified Opaleye.Internal.PrimQuery as Opaleye
24+import qualified Opaleye.Internal.QueryArr as Opaleye
25+import qualified Opaleye.Internal.Tag as Opaleye
21
26
22-- rel8
27-- rel8
23import Rel8.Expr ( Expr )
28import Rel8.Expr ( Expr )
24import Rel8.Expr.Bool ( boolExpr, not_ )
29import Rel8.Expr.Bool ( boolExpr, not_ )
25import Rel8.Expr.Eq ( (==.) )
30import Rel8.Expr.Eq ( (==.) )
26−import Rel8.Expr.Opaleye ( toColumn, toPrimExpr )
31+import Rel8.Expr.Opaleye ( toPrimExpr, traversePrimExpr )
27import Rel8.Expr.Serialize ( litExpr )
32import Rel8.Expr.Serialize ( litExpr )
28import Rel8.Query ( Query )
33import Rel8.Query ( Query )
29import Rel8.Query.Filter ( where_ )
34import Rel8.Query.Filter ( where_ )
30import Rel8.Query.Maybe ( optional )
35import Rel8.Query.Maybe ( optional )
31import Rel8.Query.Opaleye ( zipOpaleyeWith )
36import Rel8.Query.Opaleye ( zipOpaleyeWith )
32−import Rel8.Table ( Table )
33import Rel8.Table.Either ( EitherTable( EitherTable ) )
37import Rel8.Table.Either ( EitherTable( EitherTable ) )
34import Rel8.Table.Maybe ( MaybeTable( MaybeTable ), isJustTable )
38import Rel8.Table.Maybe ( MaybeTable( MaybeTable ), isJustTable )
35−import Rel8.Table.Opaleye ( unpackspec )
36−import Rel8.Table.Tag ( Tag(..) )
37import Rel8.Table.These
39import Rel8.Table.These
38− ( TheseTable( TheseTable )
40+ ( TheseTable( TheseTable, here, there )
39 , hasHereTable, hasThereTable
41 , hasHereTable, hasThereTable
40 , isThisTable, isThatTable, isThoseTable
42 , isThisTable, isThatTable, isThoseTable
41 )
43 )
@@ -43,86 +45,91 @@ import Rel8.Type.Tag ( EitherTag( IsLeft, IsRight ) )
43
45
44
46
45-- | Corresponds to a @FULL OUTER JOIN@ between two queries.
47-- | Corresponds to a @FULL OUTER JOIN@ between two queries.
46−alignBy :: (Table Expr a, Table Expr b)
48+alignBy :: ()
47 => (a -> b -> Expr Bool)
49 => (a -> b -> Expr Bool)
48− -> Query a -> Query b -> Query (TheseTable a b)
50+ -> Query a -> Query b -> Query (TheseTable Expr a b)
49−alignBy condition as bs =
51+alignBy condition = zipOpaleyeWith $ \left right -> Opaleye.stateQueryArr $ \_ t -> case t of
50− uncurry TheseTable <$> zipOpaleyeWith fullOuterJoin as bs
52+ tag -> (tab, join', tag''')
51− where
53+ where
52− fullOuterJoin a b =
54+ (ma, left', tag') = Opaleye.runStateQueryArr (pure <$> left) () tag
53− Opaleye.joinExplicit unpackspec unpackspec pure pure full a b on
55+ (mb, right', tag'') = Opaleye.runStateQueryArr (pure <$> right) () tag'
54− where
56+ MaybeTable hasHere a = ma
55− full = Opaleye.FullJoin
57+ MaybeTable hasThere b = mb
56− on = toColumn . toPrimExpr . uncurry condition
58+ (hasHere', lbindings) = Opaleye.run $ do
57−
59+ traversePrimExpr (Opaleye.extractAttr "hasHere" tag'') hasHere
58−
60+ (hasThere', rbindings) = Opaleye.run $ do
59−keepHereTable :: TheseTable a b -> Query (a, MaybeTable b)
61+ traversePrimExpr (Opaleye.extractAttr "hasThere" tag'') hasThere
62+ tag''' = Opaleye.next tag''
63+ join = Opaleye.Join Opaleye.FullJoin on left'' right''
64+ where
65+ on = toPrimExpr $ condition (extract a) (extract b)
66+ left'' = (Opaleye.NonLateral, Opaleye.toPrimQuery (left' <> Opaleye.aRebind lbindings))
67+ right'' = (Opaleye.NonLateral, Opaleye.toPrimQuery (right' <> Opaleye.aRebind rbindings))
68+ ma' = MaybeTable hasHere' a
69+ mb' = MaybeTable hasThere' b
70+ tab = TheseTable {here = ma', there = mb'}
71+ join' = Opaleye.aProduct join
72+
73+
74+keepHereTable :: TheseTable Expr a b -> Query (a, MaybeTable Expr b)
60keepHereTable = loseThatTable
75keepHereTable = loseThatTable
61
76
62
77
63−loseHereTable :: TheseTable a b -> Query b
78+loseHereTable :: TheseTable Expr a b -> Query b
64loseHereTable = keepThatTable
79loseHereTable = keepThatTable
65
80
66
81
67−keepThereTable :: TheseTable a b -> Query (MaybeTable a, b)
82+keepThereTable :: TheseTable Expr a b -> Query (MaybeTable Expr a, b)
68keepThereTable = loseThisTable
83keepThereTable = loseThisTable
69
84
70
85
71−loseThereTable :: TheseTable a b -> Query a
86+loseThereTable :: TheseTable Expr a b -> Query a
72loseThereTable = keepThisTable
87loseThereTable = keepThisTable
73
88
74
89
75−keepThisTable :: TheseTable a b -> Query a
90+keepThisTable :: TheseTable Expr a b -> Query a
76keepThisTable t@(TheseTable (MaybeTable _ a) _) = do
91keepThisTable t@(TheseTable (MaybeTable _ a) _) = do
77 where_ $ isThisTable t
92 where_ $ isThisTable t
78− pure a
93+ pure (extract a)
79
94
80
95
81−loseThisTable :: TheseTable a b -> Query (MaybeTable a, b)
96+loseThisTable :: TheseTable Expr a b -> Query (MaybeTable Expr a, b)
82loseThisTable t@(TheseTable ma (MaybeTable _ b)) = do
97loseThisTable t@(TheseTable ma (MaybeTable _ b)) = do
83 where_ $ not_ $ isThisTable t
98 where_ $ not_ $ isThisTable t
84− pure (ma, b)
99+ pure (ma, extract b)
85
100
86
101
87−keepThatTable :: TheseTable a b -> Query b
102+keepThatTable :: TheseTable Expr a b -> Query b
88keepThatTable t@(TheseTable _ (MaybeTable _ b)) = do
103keepThatTable t@(TheseTable _ (MaybeTable _ b)) = do
89 where_ $ isThatTable t
104 where_ $ isThatTable t
90− pure b
105+ pure (extract b)
91
106
92
107
93−loseThatTable :: TheseTable a b -> Query (a, MaybeTable b)
108+loseThatTable :: TheseTable Expr a b -> Query (a, MaybeTable Expr b)
94loseThatTable t@(TheseTable (MaybeTable _ a) mb) = do
109loseThatTable t@(TheseTable (MaybeTable _ a) mb) = do
95 where_ $ not_ $ isThatTable t
110 where_ $ not_ $ isThatTable t
96− pure (a, mb)
111+ pure (extract a, mb)
97
112
98
113
99−keepThoseTable :: TheseTable a b -> Query (a, b)
114+keepThoseTable :: TheseTable Expr a b -> Query (a, b)
100keepThoseTable t@(TheseTable (MaybeTable _ a) (MaybeTable _ b)) = do
115keepThoseTable t@(TheseTable (MaybeTable _ a) (MaybeTable _ b)) = do
101 where_ $ isThoseTable t
116 where_ $ isThoseTable t
102− pure (a, b)
117+ pure (extract a, extract b)
103
118
104
119
105−loseThoseTable :: TheseTable a b -> Query (EitherTable a b)
120+loseThoseTable :: TheseTable Expr a b -> Query (EitherTable Expr a b)
106loseThoseTable t@(TheseTable (MaybeTable _ a) (MaybeTable _ b)) = do
121loseThoseTable t@(TheseTable (MaybeTable _ a) (MaybeTable _ b)) = do
107 where_ $ not_ $ isThoseTable t
122 where_ $ not_ $ isThoseTable t
108− pure $ EitherTable result a b
123+ pure $ EitherTable tag a b
109 where
124 where
110 tag = boolExpr (litExpr IsLeft) (litExpr IsRight) (isThatTable t)
125 tag = boolExpr (litExpr IsLeft) (litExpr IsRight) (isThatTable t)
111− result = (mempty `asTypeOf` result) {expr = tag}
112−
113−
114−bindTheseTable :: (Table Expr a, Semigroup a, Monad m)
115− => (i -> m (TheseTable a b)) -> TheseTable a i -> m (TheseTable a b)
116−bindTheseTable query (TheseTable here (MaybeTable input i)) = do
117− TheseTable here' (MaybeTable output b) <- query i
118− pure $ TheseTable (here <> here') (MaybeTable (input <> output) b)
119
126
120
127
121bitraverseTheseTable :: ()
128bitraverseTheseTable :: ()
122 => (a -> Query c)
129 => (a -> Query c)
123 -> (b -> Query d)
130 -> (b -> Query d)
124− -> TheseTable a b
131+ -> TheseTable Expr a b
125− -> Query (TheseTable c d)
132+ -> Query (TheseTable Expr c d)
126bitraverseTheseTable f g t = do
133bitraverseTheseTable f g t = do
127 mc <- optional (f . fst =<< keepHereTable t)
134 mc <- optional (f . fst =<< keepHereTable t)
128 md <- optional (g . snd =<< keepThereTable t)
135 md <- optional (g . snd =<< keepThereTable t)
src/Rel8/Query/Window.hsnew file+26
@@ -0,0 +1,26 @@
1+module Rel8.Query.Window
2+ ( window
3+ )
4+where
5+
6+-- base
7+import Prelude ()
8+
9+-- opaleye
10+import qualified Opaleye.Window as Opaleye
11+
12+-- rel8
13+import Rel8.Query ( Query )
14+import Rel8.Query.Opaleye ( mapOpaleye )
15+import Rel8.Window ( Window( Window ) )
16+
17+
18+-- | 'window' runs a query composed of expressions containing
19+-- [window functions](https://www.postgresql.org/docs/current/tutorial-window.html).
20+-- 'window' is similar to 'Rel8.aggregate', with the main difference being
21+-- that in a window query, each input row corresponds to one output row,
22+-- whereas aggregation queries fold the entire input query down into a single
23+-- row. To put this into a Haskell context, 'Rel8.aggregate' is to 'foldl' as
24+-- 'window' is to 'scanl'.
25+window :: Window a b -> Query a -> Query b
26+window (Window a) = mapOpaleye (Opaleye.runWindows a)
src/Rel8/Schema/Column.hsdeleted−29
@@ -1,29 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language TypeFamilies #-}
3−{-# language StandaloneKindSignatures #-}
4−
5−module Rel8.Schema.Column
6− ( Column, Default
7− )
8−where
9−
10−-- base
11−import Data.Kind ( Type )
12−import Prelude ()
13−
14−-- rel8
15−import Rel8.Kind.Necessity ( Necessity( Required, Optional ) )
16−import Rel8.Schema.Field ( Field )
17−import qualified Rel8.Schema.Kind as K
18−
19−
20−-- | The @Column@ type family should be used to indicate which fields of your
21−-- data types are single columns in queries. This type family has special
22−-- support when a query is executed, allowing you to use a single data type for
23−-- both query data and rows decoded to Haskell.
24−type Column :: K.Context -> Type -> Type
25−type Column context a = Field context 'Required a
26−
27−
28−type Default :: K.Context -> Type -> Type
29−type Default context a = Field context 'Optional a
src/Rel8/Schema/Context.hsdeleted−28
@@ -1,28 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language GADTs #-}
3−{-# language StandaloneKindSignatures #-}
4−{-# language TypeFamilies #-}
5−
6−module Rel8.Schema.Context
7− ( Interpretation(..), Col( Result )
8− )
9−where
10−
11−-- base
12−import Data.Kind ( Constraint )
13−import Prelude ()
14−
15−-- rel8
16−import Rel8.Schema.Kind ( Context, HContext )
17−import Rel8.Schema.Result ( Result )
18−import Rel8.Schema.Spec ( Spec( Spec ) )
19−
20−
21−type Interpretation :: Context -> Constraint
22−class Interpretation context where
23− data Col context :: HContext
24−
25−
26−instance Interpretation Result where
27− data Col Result _spec where
28− Result :: a -> Col Result ('Spec labels necessity a)
src/Rel8/Schema/Context/Label.hsdeleted−60
@@ -1,60 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language FlexibleInstances #-}
3−{-# language StandaloneKindSignatures #-}
4−{-# language TypeFamilies #-}
5−{-# language TypeOperators #-}
6−
7−module Rel8.Schema.Context.Label
8− ( Labelable( labeler, unlabeler )
9− , HLabelable( hlabeler, hunlabeler )
10− )
11−where
12−
13−-- base
14−import Data.Kind ( Constraint )
15−import Prelude hiding ( null )
16−
17−-- rel8
18−import Rel8.Schema.Context ( Interpretation, Col(..) )
19−import Rel8.Schema.Dict ( Dict( Dict ) )
20−import Rel8.Schema.Kind ( Context, HContext )
21−import Rel8.Schema.Spec ( Spec( Spec ) )
22−import Rel8.Schema.Result ( Result )
23−import Rel8.Schema.Spec.ConstrainDBType ( ConstrainDBType )
24−
25−
26−type Labelable :: Context -> Constraint
27−class Interpretation context => Labelable context where
28− labeler :: ()
29− => Col context ('Spec labels necessity a)
30− -> Col context ('Spec (label ': labels) necessity a)
31−
32− unlabeler :: ()
33− => Col context ('Spec (label ': labels) necessity a)
34− -> Col context ('Spec labels necessity a)
35−
36−
37−instance Labelable Result where
38− labeler (Result a) = Result a
39− unlabeler (Result a) = Result a
40−
41−
42−type HLabelable :: HContext -> Constraint
43−class HLabelable context where
44− hlabeler :: ()
45− => context ('Spec labels necessity a)
46− -> context ('Spec (label ': labels) necessity a)
47−
48− hunlabeler :: ()
49− => context ('Spec (label ': labels) necessity a)
50− -> context ('Spec labels necessity a)
51−
52−
53−instance Labelable context => HLabelable (Col context) where
54− hlabeler = labeler
55− hunlabeler = unlabeler
56−
57−
58−instance HLabelable (Dict (ConstrainDBType constraint)) where
59− hlabeler Dict = Dict
60− hunlabeler Dict = Dict
src/Rel8/Schema/Context/Nullify.hs+105−160
@@ -1,199 +1,144 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2+{-# language EmptyCase #-}
2{-# language FlexibleContexts #-}
3{-# language FlexibleContexts #-}
3−{-# language FlexibleInstances #-}
4+{-# language GADTs #-}
4−{-# language InstanceSigs #-}
5+{-# language LambdaCase #-}
5−{-# language MultiParamTypeClasses #-}
6{-# language NamedFieldPuns #-}
6{-# language NamedFieldPuns #-}
7−{-# language ScopedTypeVariables #-}
8{-# language StandaloneKindSignatures #-}
7{-# language StandaloneKindSignatures #-}
9−{-# language TypeFamilies #-}
10
8
11module Rel8.Schema.Context.Nullify
9module Rel8.Schema.Context.Nullify
12− ( Nullifiable( ConstrainTag, encodeTag, decodeTag, nullifier, unnullifier )
10+ ( Nullifiability(..), NonNullifiability(..), nullifiableOrNot, absurd
13− , HNullifiable( HConstrainTag, hencodeTag, hdecodeTag, hnullifier, hunnullifier )
11+ , Nullifiable, nullifiability
14− , runTag, unnull
12+ , guarder, nullifier, unnullifier
13+ , sguard, snullify
15 )
14 )
16where
15where
17
16
18-- base
17-- base
18+import Data.Bool ( bool )
19+import Data.Functor.Identity ( Identity( Identity ) )
19import Data.Kind ( Constraint, Type )
20import Data.Kind ( Constraint, Type )
20−import GHC.TypeLits ( KnownSymbol )
21import Prelude hiding ( null )
21import Prelude hiding ( null )
22
22
23-- opaleye
23-- opaleye
24import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
24import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
25
25
26-- rel8
26-- rel8
27−import Rel8.Aggregate
27+import Rel8.Aggregate ( Aggregate(..), zipOutputs )
28− ( Aggregate, Col(..)
28+import Rel8.Expr ( Expr )
29− , mapInputs
30− , unsafeMakeAggregate
31− )
32−import Rel8.Expr ( Expr, Col(..) )
33import Rel8.Expr.Bool ( boolExpr )
29import Rel8.Expr.Bool ( boolExpr )
34import Rel8.Expr.Null ( nullify, unsafeUnnullify )
30import Rel8.Expr.Null ( nullify, unsafeUnnullify )
35−import Rel8.Expr.Opaleye ( fromPrimExpr, toPrimExpr )
31+import Rel8.Expr.Opaleye ( fromPrimExpr )
36−import Rel8.Kind.Necessity ( Necessity( Required ) )
32+import Rel8.Kind.Context ( SContext(..) )
37−import Rel8.Schema.Context ( Interpretation )
33+import Rel8.Schema.Field ( Field )
38import qualified Rel8.Schema.Kind as K
34import qualified Rel8.Schema.Kind as K
39−import Rel8.Schema.Name ( Name( Name ), Col(..) )
35+import Rel8.Schema.Name ( Name( Name ) )
40−import Rel8.Schema.Null ( Nullify, Nullity( Null, NotNull ), Sql )
36+import Rel8.Schema.Null ( Nullify, Nullity( Null, NotNull ) )
41−import Rel8.Schema.Dict ( Dict( Dict ) )
37+import Rel8.Schema.Result ( Result )
42−import Rel8.Schema.Spec ( Spec( Spec ), SSpec(..) )
38+import Rel8.Schema.Spec ( Spec(..) )
43−import Rel8.Schema.Spec.ConstrainDBType
44− ( ConstrainDBType
45− , dbTypeDict, dbTypeNullity, fromNullityDict
46− )
47−import Rel8.Table.Tag ( Tag(..), Taggable, fromAggregate, fromExpr, fromName )
48
39
49
40
50−type Nullifiable :: K.Context -> Constraint
41+type Nullifiability :: K.Context -> Type
51−class Interpretation context => Nullifiable context where
42+data Nullifiability context where
52− type ConstrainTag context :: Type -> Constraint
43+ NAggregate :: Nullifiability Aggregate
53− type ConstrainTag _context = DefaultConstrainTag
44+ NExpr :: Nullifiability Expr
54−
45+ NName :: Nullifiability Name
55− encodeTag ::
56− ( Sql (ConstrainTag context) a
57− , KnownSymbol label
58− , Taggable a
59− )
60− => Tag label a
61− -> Col context ('Spec labels 'Required a)
62−
63− decodeTag ::
64− ( Sql (ConstrainTag context) a
65− , KnownSymbol label
66− , Taggable a
67− )
68− => Col context ('Spec labels 'Required a)
69− -> Tag label a
70−
71− nullifier :: ()
72− => Tag label a
73− -> (Expr a -> Expr Bool)
74− -> SSpec ('Spec labels necessity x)
75− -> Col context ('Spec labels necessity x)
76− -> Col context ('Spec labels necessity (Nullify x))
77−
78− unnullifier :: ()
79− => SSpec ('Spec labels necessity x)
80− -> Col context ('Spec labels necessity (Nullify x))
81− -> Col context ('Spec labels necessity x)
82
46
83
47
84−instance Nullifiable Aggregate where
48+type Nullifiable :: K.Context -> Constraint
85− encodeTag Tag {aggregator, expr} =
49+class Nullifiable context where
86− Aggregation $ unsafeMakeAggregate toPrimExpr fromPrimExpr aggregator expr
50+ nullifiability :: Nullifiability context
87−
88− decodeTag (Aggregation aggregate) = fromAggregate aggregate
89−
90− nullifier Tag {expr} test SSpec {nullity} (Aggregation aggregate) =
91− Aggregation $
92− mapInputs (toPrimExpr . runTag nullity condition . fromPrimExpr) $
93− runTag nullity condition <$> aggregate
94− where
95− condition = test expr
96
51
97− unnullifier SSpec {nullity} (Aggregation aggregate) =
98− Aggregation $ unnull nullity <$> aggregate
99
52
100− {-# INLINABLE encodeTag #-}
53+instance Nullifiable Aggregate where
101− {-# INLINABLE decodeTag #-}
54+ nullifiability = NAggregate
102− {-# INLINABLE nullifier #-}
103− {-# INLINABLE unnullifier #-}
104
55
105
56
106instance Nullifiable Expr where
57instance Nullifiable Expr where
107− encodeTag Tag {expr} = DB expr
58+ nullifiability = NExpr
108− decodeTag (DB a) = fromExpr a
109− nullifier Tag {expr} test SSpec {nullity} (DB a) =
110− DB $ runTag nullity (test expr) a
111− unnullifier SSpec {nullity} (DB a) = DB $ unnull nullity a
112−
113− {-# INLINABLE encodeTag #-}
114− {-# INLINABLE decodeTag #-}
115− {-# INLINABLE nullifier #-}
116− {-# INLINABLE unnullifier #-}
117
59
118
60
119instance Nullifiable Name where
61instance Nullifiable Name where
120− encodeTag Tag {name = Name name} = NameCol name
62+ nullifiability = NName
121− decodeTag (NameCol name) = fromName (Name name)
63+
122− nullifier _ _ _ (NameCol name) = NameCol name
64+
123− unnullifier _ (NameCol name) = NameCol name
65+type NonNullifiability :: K.Context -> Type
124−
66+data NonNullifiability context where
125− {-# INLINABLE encodeTag #-}
67+ NField :: NonNullifiability (Field table)
126− {-# INLINABLE decodeTag #-}
68+ NResult :: NonNullifiability Result
127− {-# INLINABLE nullifier #-}
69+
128− {-# INLINABLE unnullifier #-}
70+
129−
71+nullifiableOrNot :: ()
130−
72+ => SContext context
131−runTag :: Nullity a -> Expr Bool -> Expr a -> Expr (Nullify a)
73+ -> Either (NonNullifiability context) (Nullifiability context)
132−runTag nullity tag a = case nullity of
74+nullifiableOrNot = \case
133− Null -> boolExpr null a tag
75+ SAggregate -> Right NAggregate
134− NotNull -> boolExpr null (nullify a) tag
76+ SExpr -> Right NExpr
77+ SField -> Left NField
78+ SName -> Right NName
79+ SResult -> Left NResult
80+
81+
82+absurd :: Nullifiability context -> NonNullifiability context -> a
83+absurd = \case
84+ NAggregate -> \case
85+ NExpr -> \case
86+ NName -> \case
87+
88+
89+guarder :: ()
90+ => SContext context
91+ -> context tag
92+ -> (tag -> Bool)
93+ -> (Expr tag -> Expr Bool)
94+ -> context (Maybe a)
95+ -> context (Maybe a)
96+guarder = \case
97+ SAggregate -> \tag _ isNonNull -> zipOutputs (sguard . isNonNull) tag
98+ SExpr -> \tag _ isNonNull -> sguard (isNonNull tag)
99+ SField -> \_ _ _ -> id
100+ SName -> \_ _ _ -> id
101+ SResult -> \(Identity tag) isNonNull _ (Identity a) ->
102+ Identity (bool Nothing a (isNonNull tag))
103+
104+
105+nullifier :: ()
106+ => Nullifiability context
107+ -> Spec a
108+ -> context a
109+ -> context (Nullify a)
110+nullifier = \case
111+ NAggregate -> \Spec {nullity} (Aggregate a) ->
112+ Aggregate $ snullify nullity <$> a
113+ NExpr -> \Spec {nullity} a -> snullify nullity a
114+ NName -> \_ (Name a) -> Name a
115+
116+
117+unnullifier :: ()
118+ => Nullifiability context
119+ -> Spec a
120+ -> context (Nullify a)
121+ -> context a
122+unnullifier = \case
123+ NAggregate -> \Spec {nullity} (Aggregate a) ->
124+ Aggregate $ sunnullify nullity <$> a
125+ NExpr -> \Spec {nullity} a -> sunnullify nullity a
126+ NName -> \_ (Name a) -> Name a
127+
128+
129+sguard :: Expr Bool -> Expr (Maybe a) -> Expr (Maybe a)
130+sguard condition a = boolExpr null a condition
135 where
131 where
136 null = fromPrimExpr $ Opaleye.ConstExpr Opaleye.NullLit
132 null = fromPrimExpr $ Opaleye.ConstExpr Opaleye.NullLit
137
133
138
134
139−unnull :: Nullity a -> Expr (Nullify a) -> Expr a
135+snullify :: Nullity a -> Expr a -> Expr (Nullify a)
140−unnull nullity a = case nullity of
136+snullify nullity a = case nullity of
141 Null -> a
137 Null -> a
142− NotNull -> unsafeUnnullify a
138+ NotNull -> nullify a
143−
144
139
145−type HNullifiable :: K.HContext -> Constraint
146−class HNullifiable context where
147− type HConstrainTag context :: Type -> Constraint
148− type HConstrainTag _context = DefaultConstrainTag
149
140
150− hencodeTag :: (Sql (HConstrainTag context) a, KnownSymbol label, Taggable a)
141+sunnullify :: Nullity a -> Expr (Nullify a) -> Expr a
151− => Tag label a
142+sunnullify nullity a = case nullity of
152− -> context ('Spec labels 'Required a)
143+ Null -> a
153−
144+ NotNull -> unsafeUnnullify a
154− hdecodeTag :: (Sql (HConstrainTag context) a, KnownSymbol label, Taggable a)
155− => context ('Spec labels 'Required a)
156− -> Tag label a
157−
158− hnullifier :: ()
159− => Tag label a
160− -> (Expr a -> Expr Bool)
161− -> SSpec ('Spec labels necessity x)
162− -> context ('Spec labels necessity x)
163− -> context ('Spec labels necessity (Nullify x))
164−
165− hunnullifier :: ()
166− => SSpec ('Spec labels necessity x)
167− -> context ('Spec labels necessity (Nullify x))
168− -> context ('Spec labels necessity x)
169−
170−
171−instance Nullifiable context => HNullifiable (Col context) where
172− type HConstrainTag (Col context) = ConstrainTag context
173− hencodeTag = encodeTag
174− hdecodeTag = decodeTag
175− hnullifier = nullifier
176− hunnullifier = unnullifier
177−
178−
179−instance HNullifiable (Dict (ConstrainDBType constraint)) where
180− type HConstrainTag (Dict (ConstrainDBType constraint)) = constraint
181−
182− hencodeTag _ = Dict
183− hdecodeTag = mempty
184−
185− hnullifier _ _ SSpec {} dict = case dbTypeDict dict of
186− Dict -> case dbTypeNullity dict of
187− Null -> Dict
188− NotNull -> Dict
189−
190− hunnullifier SSpec {nullity} dict = case dbTypeDict dict of
191− Dict -> case nullity of
192− Null -> Dict
193− NotNull -> case dbTypeNullity dict of
194− Null -> fromNullityDict nullity Dict
195−
196−
197−type DefaultConstrainTag :: Type -> Constraint
198−class DefaultConstrainTag a
199−instance DefaultConstrainTag a
src/Rel8/Schema/Field.hs+23−669
@@ -1,696 +1,50 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2{-# language FlexibleContexts #-}
2{-# language FlexibleContexts #-}
3−{-# language GADTs #-}
4−{-# language LambdaCase #-}
5{-# language MultiParamTypeClasses #-}
3{-# language MultiParamTypeClasses #-}
6−{-# language RankNTypes #-}
7{-# language StandaloneKindSignatures #-}
4{-# language StandaloneKindSignatures #-}
8{-# language TypeFamilies #-}
5{-# language TypeFamilies #-}
9−{-# language UndecidableInstances #-}
10
6
11module Rel8.Schema.Field
7module Rel8.Schema.Field
12− ( Field
8+ ( Field(..)
13− , HEither, HList, HMaybe, HNonEmpty, HThese
9+ , fields
14− , AField(..)
15− , AHEither(..), AHList(..), AHMaybe(..), AHNonEmpty(..), AHThese(..)
16 )
10 )
17where
11where
18
12
19-- base
13-- base
20−import Control.Applicative ( liftA2 )
14+import Data.Functor.Identity ( Identity( Identity ) )
21−import Data.Bifunctor ( Bifunctor, bimap )
22import Data.Kind ( Type )
15import Data.Kind ( Type )
23−import Data.List.NonEmpty ( NonEmpty )
24import Prelude
16import Prelude
25
17
26-- rel8
18-- rel8
27−import Rel8.Aggregate ( Aggregate, Col(..) )
19+import Rel8.Schema.HTable ( HField, htabulate )
28−import Rel8.Expr ( Expr, Col(..) )
29−import Rel8.Kind.Context ( SContext(..), Reifiable( contextSing ) )
30−import Rel8.Kind.Necessity
31− ( Necessity( Required, Optional )
32− , SNecessity( SRequired, SOptional )
33− , KnownNecessity, necessitySing
34− )
35−import Rel8.Schema.Context ( Col(..) )
36−import Rel8.Schema.HTable.Either ( HEitherTable )
37−import Rel8.Schema.HTable.List ( HListTable )
38−import Rel8.Schema.HTable.Maybe ( HMaybeTable )
39−import Rel8.Schema.HTable.NonEmpty ( HNonEmptyTable )
40−import Rel8.Schema.HTable.These ( HTheseTable )
41import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
20import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
42−import Rel8.Schema.Insert ( Insert, Col(..) )
21+import Rel8.Schema.Kind as K
43−import qualified Rel8.Schema.Kind as K
44−import Rel8.Schema.Name ( Name(..), Col(..) )
45import Rel8.Schema.Null ( Sql )
22import Rel8.Schema.Null ( Sql )
46−import Rel8.Schema.Reify ( Reify, Col(..), hreify, hunreify )
47−import Rel8.Schema.Result ( Result )
48−import Rel8.Schema.Spec ( Spec( Spec ) )
49import Rel8.Table
23import Rel8.Table
50− ( Table, Columns, Congruent, Context, fromColumns, toColumns
24+ ( Table, Columns, Context, fromColumns, toColumns
51− , Unreify, reify, unreify
25+ , FromExprs, fromResult, toResult
26+ , Transpose
52 )
27 )
53−import Rel8.Table.Either ( EitherTable )
28+import Rel8.Table.Transpose ( Transposes )
54−import Rel8.Table.List ( ListTable( ListTable ) )
55−import Rel8.Table.Maybe ( MaybeTable )
56−import Rel8.Table.NonEmpty ( NonEmptyTable( NonEmptyTable ) )
57−import Rel8.Table.Recontextualize ( Recontextualize )
58−import Rel8.Table.These ( TheseTable )
59−import Rel8.Table.Unreify ( Unreifiable )
60import Rel8.Type ( DBType )
29import Rel8.Type ( DBType )
61
30
62−-- these
63−import Data.These ( These )
64−
65−
66−type Field :: K.Context -> Necessity -> Type -> Type
67−type family Field context necessity a where
68− Field (Reify context) necessity a = AField context necessity a
69− Field Aggregate _necessity a = Aggregate (Expr a)
70− Field Expr _necessity a = Expr a
71− Field Insert 'Required a = Expr a
72− Field Insert 'Optional a = Maybe (Expr a)
73− Field Name _necessity a = Name a
74− Field Result _necessity a = a
75−
76−
77−type HEither :: K.Context -> Type -> Type -> Type
78−type family HEither context where
79− HEither (Reify context) = AHEither context
80− HEither Aggregate = EitherTable
81− HEither Expr = EitherTable
82− HEither Insert = EitherTable
83− HEither Name = EitherTable
84− HEither Result = Either
85−
86−
87−type HList :: K.Context -> Type -> Type
88−type family HList context where
89− HList (Reify context) = AHList context
90− HList Aggregate = ListTable
91− HList Expr = ListTable
92− HList Insert = ListTable
93− HList Name = ListTable
94− HList Result = []
95−
96−
97−type HMaybe :: K.Context -> Type -> Type
98−type family HMaybe context where
99− HMaybe (Reify context) = AHMaybe context
100− HMaybe Aggregate = MaybeTable
101− HMaybe Expr = MaybeTable
102− HMaybe Insert = MaybeTable
103− HMaybe Name = MaybeTable
104− HMaybe Result = Maybe
105−
106−
107−type HNonEmpty :: K.Context -> Type -> Type
108−type family HNonEmpty context where
109− HNonEmpty (Reify context) = AHNonEmpty context
110− HNonEmpty Aggregate = NonEmptyTable
111− HNonEmpty Expr = NonEmptyTable
112− HNonEmpty Insert = NonEmptyTable
113− HNonEmpty Name = NonEmptyTable
114− HNonEmpty Result = NonEmpty
115−
116−
117−type HThese :: K.Context -> Type -> Type -> Type
118−type family HThese context where
119− HThese (Reify context) = AHThese context
120− HThese Aggregate = TheseTable
121− HThese Expr = TheseTable
122− HThese Insert = TheseTable
123− HThese Name = TheseTable
124− HThese Result = These
125−
126−
127−type AField :: K.Context -> Necessity -> Type -> Type
128−newtype AField context necessity a = AField (Field context necessity a)
129−
130−
131−instance (Reifiable context, KnownNecessity necessity, Sql DBType a) =>
132− Table (Reify context) (AField context necessity a)
133− where
134− type Context (AField context necessity a) = Reify context
135− type Columns (AField context necessity a) = HIdentity ('Spec '[""] necessity a)
136− type Unreify (AField context necessity a) = Field context necessity a
137−
138− fromColumns (HIdentity (Reify a)) = sfromColumn contextSing a
139− toColumns = HIdentity . Reify . stoColumn contextSing necessitySing
140− reify _ = AField
141− unreify _ (AField a) = a
142−
143−
144−instance
145− ( Reifiable context, Reifiable context'
146− , KnownNecessity necessity, Sql DBType a
147− ) =>
148− Recontextualize
149− (Reify context)
150− (Reify context')
151− (AField context necessity a)
152− (AField context' necessity a)
153−
154−
155−type AHEither :: K.Context -> Type -> Type -> Type
156−newtype AHEither context a b = AHEither (HEither context a b)
157−
158−
159−instance Reifiable context => Bifunctor (AHEither context) where
160− bimap = sbimapEither contextSing
161−
162−
163−instance Reifiable context => Functor (AHEither context a) where
164− fmap = bimap id
165−
166−
167−instance (Reifiable context, Table (Reify context) a, Table (Reify context) b)
168− => Table (Reify context) (AHEither context a b)
169− where
170− type Context (AHEither context a b) = Reify context
171− type Columns (AHEither context a b) = HEitherTable (Columns a) (Columns b)
172− type Unreify (AHEither context a b) = HEither context (Unreify a) (Unreify b)
173−
174− fromColumns = sfromColumnsEither contextSing
175− toColumns = stoColumnsEither contextSing
176− reify proof = liftA2 bimap reify reify proof . AHEither
177− unreify proof = (\(AHEither a) -> a) . liftA2 bimap unreify unreify proof
178−
179−
180−instance
181− ( Reifiable context, Reifiable context'
182− , Recontextualize (Reify context) (Reify context') a a'
183− , Recontextualize (Reify context) (Reify context') b b'
184− ) =>
185− Recontextualize
186− (Reify context)
187− (Reify context')
188− (AHEither context a b)
189− (AHEither context' a' b')
190−
191−
192−type AHList :: K.Context -> Type -> Type
193−newtype AHList context a = AHList (HList context a)
194−
195−
196−instance
197− ( Reifiable context
198− , Table (Reify context) a
199− , Unreifiable (Reify context) a
200− )
201− => Table (Reify context) (AHList context a)
202− where
203− type Context (AHList context a) = Reify context
204− type Columns (AHList context a) = HListTable (Columns a)
205− type Unreify (AHList context a) = HList context (Unreify a)
206−
207− fromColumns = sfromColumnsList contextSing
208− toColumns = stoColumnsList contextSing
209− reify proof =
210− smapList contextSing (reify proof) hreify .
211− AHList
212− unreify proof =
213− (\(AHList a) -> a) .
214− smapList contextSing (unreify proof) hunreify
215−
216−
217−instance
218− ( Reifiable context, Reifiable context'
219− , Unreifiable (Reify context) a, Unreifiable (Reify context') a'
220− , Recontextualize (Reify context) (Reify context') a a'
221− ) =>
222− Recontextualize
223− (Reify context)
224− (Reify context')
225− (AHList context a)
226− (AHList context' a')
227−
228−
229−type AHMaybe :: K.Context -> Type -> Type
230−newtype AHMaybe context a = AHMaybe (HMaybe context a)
231−
232−
233−instance Reifiable context => Functor (AHMaybe context) where
234− fmap = smapMaybe contextSing
235−
236−
237−instance (Reifiable context, Table (Reify context) a) =>
238− Table (Reify context) (AHMaybe context a)
239− where
240− type Context (AHMaybe context a) = Reify context
241− type Columns (AHMaybe context a) = HMaybeTable (Columns a)
242− type Unreify (AHMaybe context a) = HMaybe context (Unreify a)
243−
244− fromColumns = sfromColumnsMaybe contextSing
245− toColumns = stoColumnsMaybe contextSing
246− reify proof = fmap fmap reify proof . AHMaybe
247− unreify proof = (\(AHMaybe a) -> a) . fmap fmap unreify proof
248−
249−
250−instance
251− ( Reifiable context, Reifiable context'
252− , Recontextualize (Reify context) (Reify context') a a'
253− ) =>
254− Recontextualize
255− (Reify context)
256− (Reify context')
257− (AHMaybe context a)
258− (AHMaybe context' a')
259−
260−
261−type AHNonEmpty :: K.Context -> Type -> Type
262−newtype AHNonEmpty context a = AHNonEmpty (HNonEmpty context a)
263−
264−
265−instance
266− ( Reifiable context
267− , Table (Reify context) a
268− , Unreifiable (Reify context) a
269− )
270− => Table (Reify context) (AHNonEmpty context a)
271− where
272− type Context (AHNonEmpty context a) = Reify context
273− type Columns (AHNonEmpty context a) = HNonEmptyTable (Columns a)
274− type Unreify (AHNonEmpty context a) = HNonEmpty context (Unreify a)
275−
276− fromColumns = sfromColumnsNonEmpty contextSing
277− toColumns = stoColumnsNonEmpty contextSing
278− reify proof =
279− smapNonEmpty contextSing (reify proof) hreify .
280− AHNonEmpty
281− unreify proof =
282− (\(AHNonEmpty a) -> a) .
283− smapNonEmpty contextSing (unreify proof) hunreify
284−
285−
286−instance
287− ( Reifiable context, Reifiable context'
288− , Unreifiable (Reify context) a, Unreifiable (Reify context') a'
289− , Recontextualize (Reify context) (Reify context') a a'
290− ) =>
291− Recontextualize
292− (Reify context)
293− (Reify context')
294− (AHNonEmpty context a)
295− (AHNonEmpty context' a')
296−
297−
298−type AHThese :: K.Context -> Type -> Type -> Type
299−newtype AHThese context a b = AHThese (HThese context a b)
300−
301−
302−instance Reifiable context => Bifunctor (AHThese context) where
303− bimap = sbimapThese contextSing
304−
305−
306−instance Reifiable context => Functor (AHThese context a) where
307− fmap = bimap id
308−
309−
310−instance (Reifiable context, Table (Reify context) a, Table (Reify context) b)
311− => Table (Reify context) (AHThese context a b)
312− where
313− type Context (AHThese context a b) = Reify context
314− type Columns (AHThese context a b) = HTheseTable (Columns a) (Columns b)
315− type Unreify (AHThese context a b) = HThese context (Unreify a) (Unreify b)
316−
317− fromColumns = sfromColumnsThese contextSing
318− toColumns = stoColumnsThese contextSing
319− reify proof = liftA2 bimap reify reify proof . AHThese
320− unreify proof = (\(AHThese a) -> a) . liftA2 bimap unreify unreify proof
321−
322−
323−instance
324− ( Reifiable context, Reifiable context'
325− , Recontextualize (Reify context) (Reify context') a a'
326− , Recontextualize (Reify context) (Reify context') b b'
327− ) =>
328− Recontextualize
329− (Reify context)
330− (Reify context')
331− (AHThese context a b)
332− (AHThese context' a' b')
333−
334−
335−sfromColumn :: ()
336− => SContext context
337− -> Col context ('Spec labels necessity a)
338− -> AField context necessity a
339−sfromColumn = \case
340− SAggregate -> \(Aggregation a) -> AField a
341− SExpr -> \(DB a) -> AField a
342− SResult -> \(Result a) -> AField a
343− SInsert -> \case
344− RequiredInsert a -> AField a
345− OptionalInsert a -> AField a
346− SName -> \(NameCol a) -> AField (Name a)
347− SReify context -> \(Reify a) -> AField (sfromColumn context a)
348−
349−
350−stoColumn :: ()
351− => SContext context
352− -> SNecessity necessity
353− -> AField context necessity a
354− -> Col context ('Spec labels necessity a)
355−stoColumn = \case
356− SAggregate -> \_ (AField a) -> Aggregation a
357− SExpr -> \_ (AField a) -> DB a
358− SResult -> \_ (AField a) -> Result a
359− SInsert -> \case
360− SRequired -> \(AField a) -> RequiredInsert a
361− SOptional -> \(AField a) -> OptionalInsert a
362− SName -> \_ (AField (Name a)) -> NameCol a
363− SReify context ->
364− \necessity (AField a) -> Reify (stoColumn context necessity a)
365−
366−
367−sbimapEither :: ()
368− => SContext context
369− -> (a -> c)
370− -> (b -> d)
371− -> AHEither context a b
372− -> AHEither context c d
373−sbimapEither = \case
374− SAggregate -> \f g (AHEither a) -> AHEither (bimap f g a)
375− SExpr -> \f g (AHEither a) -> AHEither (bimap f g a)
376− SResult -> \f g (AHEither a) -> AHEither (bimap f g a)
377− SInsert -> \f g (AHEither a) -> AHEither (bimap f g a)
378− SName -> \f g (AHEither a) -> AHEither (bimap f g a)
379− SReify context -> \f g (AHEither a) -> AHEither (sbimapEither context f g a)
380−
381−
382−sfromColumnsEither :: (Table (Reify context) a, Table (Reify context) b)
383− => SContext context
384− -> HEitherTable (Columns a) (Columns b) (Col (Reify context))
385− -> AHEither context a b
386−sfromColumnsEither = \case
387− SAggregate ->
388− AHEither .
389− bimap (fromColumns . hreify) (fromColumns . hreify) .
390− fromColumns .
391− hunreify
392− SExpr ->
393− AHEither .
394− bimap (fromColumns . hreify) (fromColumns . hreify) .
395− fromColumns .
396− hunreify
397− SResult ->
398− AHEither .
399− bimap (fromColumns . hreify) (fromColumns . hreify) .
400− fromColumns .
401− hunreify
402− SInsert ->
403− AHEither .
404− bimap (fromColumns . hreify) (fromColumns . hreify) .
405− fromColumns .
406− hunreify
407− SName ->
408− AHEither .
409− bimap (fromColumns . hreify) (fromColumns . hreify) .
410− fromColumns .
411− hunreify
412− SReify context ->
413− AHEither .
414− sbimapEither context (fromColumns . hreify) (fromColumns . hreify) .
415− sfromColumnsEither context .
416− hunreify
417−
418−
419−stoColumnsEither :: (Table (Reify context) a, Table (Reify context) b)
420− => SContext context
421− -> AHEither context a b
422− -> HEitherTable (Columns a) (Columns b) (Col (Reify context))
423−stoColumnsEither = \case
424− SAggregate ->
425− hreify .
426− toColumns .
427− bimap (hunreify . toColumns) (hunreify . toColumns) .
428− (\(AHEither a) -> a)
429− SExpr ->
430− hreify .
431− toColumns .
432− bimap (hunreify . toColumns) (hunreify . toColumns) .
433− (\(AHEither a) -> a)
434− SResult ->
435− hreify .
436− toColumns .
437− bimap (hunreify . toColumns) (hunreify . toColumns) .
438− (\(AHEither a) -> a)
439− SInsert ->
440− hreify .
441− toColumns .
442− bimap (hunreify . toColumns) (hunreify . toColumns) .
443− (\(AHEither a) -> a)
444− SName ->
445− hreify .
446− toColumns .
447− bimap (hunreify . toColumns) (hunreify . toColumns) .
448− (\(AHEither a) -> a)
449− SReify context ->
450− hreify .
451− stoColumnsEither context .
452− sbimapEither context (hunreify . toColumns) (hunreify . toColumns) .
453− (\(AHEither a) -> a)
454−
455−
456−smapList :: Congruent a b
457− => SContext context
458− -> (a -> b)
459− -> (HListTable (Columns a) (Col (Context a)) -> HListTable (Columns b) (Col (Context b)))
460− -> AHList context a
461− -> AHList context b
462−smapList = \case
463− SAggregate -> \_ f (AHList (ListTable a)) -> AHList (ListTable (f a))
464− SExpr -> \_ f (AHList (ListTable a)) -> AHList (ListTable (f a))
465− SResult -> \f _ (AHList as) -> AHList (fmap f as)
466− SInsert -> \_ f (AHList (ListTable a)) -> AHList (ListTable (f a))
467− SName -> \_ f (AHList (ListTable a)) -> AHList (ListTable (f a))
468− SReify context -> \f g (AHList as) -> AHList (smapList context f g as)
469−
470−
471−sfromColumnsList :: Table (Reify context) a
472− => SContext context
473− -> HListTable (Columns a) (Col (Reify context))
474− -> AHList context a
475−sfromColumnsList = \case
476− SAggregate -> AHList . ListTable
477− SExpr -> AHList . ListTable
478− SResult -> AHList . fmap (fromColumns . hreify) . fromColumns . hunreify
479− SInsert -> AHList . ListTable
480− SName -> AHList . ListTable
481− SReify context ->
482− AHList .
483− smapList context (fromColumns . hreify) hreify .
484− sfromColumnsList context .
485− hunreify
486−
487−
488−stoColumnsList :: Table (Reify context) a
489− => SContext context
490− -> AHList context a
491− -> HListTable (Columns a) (Col (Reify context))
492−stoColumnsList = \case
493− SAggregate -> \(AHList (ListTable a)) -> a
494− SExpr -> \(AHList (ListTable a)) -> a
495− SResult ->
496− hreify . toColumns . fmap (hunreify . toColumns) . (\(AHList a) -> a)
497− SInsert -> \(AHList (ListTable a)) -> a
498− SName -> \(AHList (ListTable a)) -> a
499− SReify context ->
500− hreify .
501− stoColumnsList context .
502− smapList context (hunreify . toColumns) hunreify .
503− (\(AHList a) -> a)
504−
505−
506−smapMaybe :: ()
507− => SContext context
508− -> (a -> b)
509− -> AHMaybe context a
510− -> AHMaybe context b
511−smapMaybe = \case
512− SAggregate -> \f (AHMaybe a) -> AHMaybe (fmap f a)
513− SExpr -> \f (AHMaybe a) -> AHMaybe (fmap f a)
514− SResult -> \f (AHMaybe a) -> AHMaybe (fmap f a)
515− SInsert -> \f (AHMaybe a) -> AHMaybe (fmap f a)
516− SName -> \f (AHMaybe a) -> AHMaybe (fmap f a)
517− SReify context -> \f (AHMaybe a) -> AHMaybe (smapMaybe context f a)
518−
519−
520−sfromColumnsMaybe :: Table (Reify context) a
521− => SContext context
522− -> HMaybeTable (Columns a) (Col (Reify context))
523− -> AHMaybe context a
524−sfromColumnsMaybe = \case
525− SAggregate -> AHMaybe . fmap (fromColumns . hreify) . fromColumns . hunreify
526− SExpr -> AHMaybe . fmap (fromColumns . hreify) . fromColumns . hunreify
527− SResult -> AHMaybe . fmap (fromColumns . hreify) . fromColumns . hunreify
528− SInsert -> AHMaybe . fmap (fromColumns . hreify) . fromColumns . hunreify
529− SName -> AHMaybe . fmap (fromColumns . hreify) . fromColumns . hunreify
530− SReify context ->
531− AHMaybe .
532− smapMaybe context (fromColumns . hreify) .
533− sfromColumnsMaybe context .
534− hunreify
535−
536−
537−stoColumnsMaybe :: Table (Reify context) a
538− => SContext context
539− -> AHMaybe context a
540− -> HMaybeTable (Columns a) (Col (Reify context))
541−stoColumnsMaybe = \case
542− SAggregate ->
543− hreify . toColumns . fmap (hunreify . toColumns) . (\(AHMaybe a) -> a)
544− SExpr ->
545− hreify . toColumns . fmap (hunreify . toColumns) . (\(AHMaybe a) -> a)
546− SResult ->
547− hreify . toColumns . fmap (hunreify . toColumns) . (\(AHMaybe a) -> a)
548− SInsert ->
549− hreify . toColumns . fmap (hunreify . toColumns) . (\(AHMaybe a) -> a)
550− SName ->
551− hreify . toColumns . fmap (hunreify . toColumns) . (\(AHMaybe a) -> a)
552− SReify context ->
553− hreify .
554− stoColumnsMaybe context .
555− smapMaybe context (hunreify . toColumns) .
556− (\(AHMaybe a) -> a)
557−
558−
559−smapNonEmpty :: Congruent a b
560− => SContext context
561− -> (a -> b)
562− -> (HNonEmptyTable (Columns a) (Col (Context a)) -> HNonEmptyTable (Columns b) (Col (Context b)))
563− -> AHNonEmpty context a
564− -> AHNonEmpty context b
565−smapNonEmpty = \case
566− SAggregate -> \_ f (AHNonEmpty (NonEmptyTable a)) -> AHNonEmpty (NonEmptyTable (f a))
567− SExpr -> \_ f (AHNonEmpty (NonEmptyTable a)) -> AHNonEmpty (NonEmptyTable (f a))
568− SResult -> \f _ (AHNonEmpty as) -> AHNonEmpty (fmap f as)
569− SInsert -> \_ f (AHNonEmpty (NonEmptyTable a)) -> AHNonEmpty (NonEmptyTable (f a))
570− SName -> \_ f (AHNonEmpty (NonEmptyTable a)) -> AHNonEmpty (NonEmptyTable (f a))
571− SReify context -> \f g (AHNonEmpty as) -> AHNonEmpty (smapNonEmpty context f g as)
572−
573−
574−sfromColumnsNonEmpty :: Table (Reify context) a
575− => SContext context
576− -> HNonEmptyTable (Columns a) (Col (Reify context))
577− -> AHNonEmpty context a
578−sfromColumnsNonEmpty = \case
579− SAggregate -> AHNonEmpty . NonEmptyTable
580− SExpr -> AHNonEmpty . NonEmptyTable
581− SResult ->
582− AHNonEmpty . fmap (fromColumns . hreify) . fromColumns . hunreify
583− SInsert -> AHNonEmpty . NonEmptyTable
584− SName -> AHNonEmpty . NonEmptyTable
585− SReify context ->
586− AHNonEmpty .
587− smapNonEmpty context (fromColumns . hreify) hreify .
588− sfromColumnsNonEmpty context .
589− hunreify
590−
591−
592−stoColumnsNonEmpty :: Table (Reify context) a
593− => SContext context
594− -> AHNonEmpty context a
595− -> HNonEmptyTable (Columns a) (Col (Reify context))
596−stoColumnsNonEmpty = \case
597− SAggregate -> \(AHNonEmpty (NonEmptyTable a)) -> a
598− SExpr -> \(AHNonEmpty (NonEmptyTable a)) -> a
599− SResult ->
600− hreify . toColumns . fmap (hunreify . toColumns) . (\(AHNonEmpty a) -> a)
601− SInsert -> \(AHNonEmpty (NonEmptyTable a)) -> a
602− SName -> \(AHNonEmpty (NonEmptyTable a)) -> a
603− SReify context ->
604− hreify .
605− stoColumnsNonEmpty context .
606− smapNonEmpty context (hunreify . toColumns) hunreify .
607− (\(AHNonEmpty a) -> a)
608
31
32+-- | A special context used in the construction of 'Rel8.Projection's.
33+type Field :: Type -> K.Context
34+newtype Field table a = Field (HField (Columns table) a)
609
35
610−sbimapThese :: ()
611− => SContext context
612− -> (a -> c)
613− -> (b -> d)
614− -> AHThese context a b
615− -> AHThese context c d
616−sbimapThese = \case
617− SAggregate -> \f g (AHThese a) -> AHThese (bimap f g a)
618− SExpr -> \f g (AHThese a) -> AHThese (bimap f g a)
619− SResult -> \f g (AHThese a) -> AHThese (bimap f g a)
620− SInsert -> \f g (AHThese a) -> AHThese (bimap f g a)
621− SName -> \f g (AHThese a) -> AHThese (bimap f g a)
622− SReify context -> \f g (AHThese a) -> AHThese (sbimapThese context f g a)
623
36
37+instance Sql DBType a => Table (Field table) (Field table a) where
38+ type Columns (Field table a) = HIdentity a
39+ type Context (Field table a) = Field table
40+ type FromExprs (Field table a) = a
41+ type Transpose to (Field table a) = to a
624
42
625−sfromColumnsThese :: (Table (Reify context) a, Table (Reify context) b)
43+ toColumns = HIdentity
626− => SContext context
44+ fromColumns (HIdentity a) = a
627− -> HTheseTable (Columns a) (Columns b) (Col (Reify context))
45+ toResult a = HIdentity (Identity a)
628− -> AHThese context a b
46+ fromResult (HIdentity (Identity a)) = a
629−sfromColumnsThese = \case
630− SAggregate ->
631− AHThese .
632− bimap (fromColumns . hreify) (fromColumns . hreify) .
633− fromColumns .
634− hunreify
635− SExpr ->
636− AHThese .
637− bimap (fromColumns . hreify) (fromColumns . hreify) .
638− fromColumns .
639− hunreify
640− SResult ->
641− AHThese .
642− bimap (fromColumns . hreify) (fromColumns . hreify) .
643− fromColumns .
644− hunreify
645− SInsert ->
646− AHThese .
647− bimap (fromColumns . hreify) (fromColumns . hreify) .
648− fromColumns .
649− hunreify
650− SName ->
651− AHThese .
652− bimap (fromColumns . hreify) (fromColumns . hreify) .
653− fromColumns .
654− hunreify
655− SReify context ->
656− AHThese .
657− sbimapThese context (fromColumns . hreify) (fromColumns . hreify) .
658− sfromColumnsThese context .
659− hunreify
660
47
661
48
662−stoColumnsThese :: (Table (Reify context) a, Table (Reify context) b)
49+fields :: Transposes context (Field table) table fields => fields
663− => SContext context
50+fields = fromColumns $ htabulate Field
664− -> AHThese context a b
665− -> HTheseTable (Columns a) (Columns b) (Col (Reify context))
666−stoColumnsThese = \case
667− SAggregate ->
668− hreify .
669− toColumns .
670− bimap (hunreify . toColumns) (hunreify . toColumns) .
671− (\(AHThese a) -> a)
672− SExpr ->
673− hreify .
674− toColumns .
675− bimap (hunreify . toColumns) (hunreify . toColumns) .
676− (\(AHThese a) -> a)
677− SResult ->
678− hreify .
679− toColumns .
680− bimap (hunreify . toColumns) (hunreify . toColumns) .
681− (\(AHThese a) -> a)
682− SInsert ->
683− hreify .
684− toColumns .
685− bimap (hunreify . toColumns) (hunreify . toColumns) .
686− (\(AHThese a) -> a)
687− SName ->
688− hreify .
689− toColumns .
690− bimap (hunreify . toColumns) (hunreify . toColumns) .
691− (\(AHThese a) -> a)
692− SReify context ->
693− hreify .
694− stoColumnsThese context .
695− sbimapThese context (hunreify . toColumns) (hunreify . toColumns) .
696− (\(AHThese a) -> a)
src/Rel8/Schema/Generic.hsdeleted−183
@@ -1,183 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language DefaultSignatures #-}
3−{-# language FlexibleContexts #-}
4−{-# language FlexibleInstances #-}
5−{-# language MultiParamTypeClasses #-}
6−{-# language ScopedTypeVariables #-}
7−{-# language StandaloneKindSignatures #-}
8−{-# language TypeApplications #-}
9−{-# language TypeFamilies #-}
10−{-# language UndecidableInstances #-}
11−
12−{-# options_ghc -fno-warn-orphans #-}
13−
14−module Rel8.Schema.Generic
15− ( Rel8able
16− , KRel8able
17− )
18−where
19−
20−-- base
21−import Data.Kind ( Constraint, Type )
22−import Data.Proxy ( Proxy( Proxy ) )
23−import Data.Type.Equality ( (:~:)( Refl ) )
24−import GHC.Generics ( Generic, Rep, from, to )
25−import Prelude
26−
27−-- rel8
28−import Rel8.Kind.Context
29− ( SContext( SReify )
30− , Reifiable, contextSing
31− , sLabelable, sReifiable
32− )
33−import Rel8.Generic.Map ( GMap, GMappable, gmap, gunmap )
34−import Rel8.Generic.Record ( Record(..) )
35−import Rel8.Generic.Table ( GTable, GColumns, fromGColumns, toGColumns )
36−import Rel8.Schema.Context ( Col )
37−import Rel8.Schema.Context.Label ( Labelable )
38−import Rel8.Schema.Dict ( Dict( Dict ) )
39−import Rel8.Schema.HTable ( HTable )
40−import qualified Rel8.Schema.Kind as K
41−import Rel8.Schema.Name ( Name )
42−import Rel8.Schema.Reify ( Reify, UnwrapReify, hreify, hunreify )
43−import Rel8.Table
44− ( Table, Columns, Context, fromColumns, toColumns
45− , Unreify, reify, unreify
46− , TTable, TColumns, TUnreify
47− )
48−
49−
50−instance (Rel8able t, Labelable context, Reifiable context) =>
51− Table context (t context)
52− where
53− type Columns (t context) = GRep t
54− type Context (t context) = context
55− type Unreify (t context) = t (UnwrapReify context)
56−
57− fromColumns = gunreify . gfromColumns . hreify
58− toColumns = hunreify . gtoColumns . greify
59−
60− reify Refl = case contextSing @context of
61− SReify context -> case sLabelable context of
62− Dict -> case sReifiable context of
63− Dict -> greify
64−
65− unreify Refl = case contextSing @context of
66− SReify context -> case sLabelable context of
67− Dict -> case sReifiable context of
68− Dict -> gunreify
69−
70−
71−type KRel8able :: Type
72−type KRel8able = K.Table
73−
74−
75−-- | This type class allows you to define custom 'Table's using higher-kinded
76−-- data types. Higher-kinded data types are data types of the pattern:
77−--
78−-- @
79−-- data MyType f =
80−-- MyType { field1 :: Column f T1 OR HK1 f
81−-- , field2 :: Column f T2 OR HK2 f
82−-- , ...
83−-- , fieldN :: Column f Tn OR HKn f
84−-- }
85−-- @
86−--
87−-- where @Tn@ is any Haskell type, and @HKn@ is any higher-kinded type.
88−--
89−-- That is, higher-kinded data are records where all fields in the record are
90−-- all either of the type @Column f T@ (for any @T@), or are themselves
91−-- higher-kinded data:
92−--
93−-- [Nested]
94−--
95−-- @
96−-- data Nested f =
97−-- Nested { nested1 :: MyType f
98−-- , nested2 :: MyType f
99−-- }
100−-- @
101−--
102−-- The @Rel8able@ type class is used to give us a special mapping operation
103−-- that lets us change the type parameter @f@.
104−--
105−-- [Supplying @Rel8able@ instances]
106−--
107−-- This type class should be derived generically for all table types in your
108−-- project. To do this, enable the @DeriveAnyType@ and @DeriveGeneric@ language
109−-- extensions:
110−--
111−-- @
112−-- \{\-\# LANGUAGE DeriveAnyClass, DeriveGeneric #-\}
113−--
114−-- data MyType f = MyType { fieldA :: Column f T }
115−-- deriving ( GHC.Generics.Generic, Rel8able )
116−-- @
117−type Rel8able :: KRel8able -> Constraint
118−class HTable (GRep t) => Rel8able t where
119− type GRep t :: K.HTable
120−
121− gfromColumns :: (Labelable context, Reifiable context)
122− => GRep t (Col (Reify context)) -> t (Reify context)
123−
124− gtoColumns :: (Labelable context, Reifiable context)
125− => t (Reify context) -> GRep t (Col (Reify context))
126−
127− greify :: (Labelable context, Reifiable context)
128− => t context -> t (Reify context)
129−
130− gunreify :: (Labelable context, Reifiable context)
131− => t (Reify context) -> t context
132−
133− type GRep t = GColumns TColumns (Rep (Record (t (Reify Name))))
134−
135− default gfromColumns :: forall context.
136− ( Generic (Record (t (Reify context)))
137− , GColumns TColumns (Rep (Record (t (Reify context)))) ~ GRep t
138− , GTable (TTable (Reify context)) TColumns (Col (Reify context)) (Rep (Record (t (Reify context))))
139− )
140− => GRep t (Col (Reify context)) -> t (Reify context)
141− gfromColumns =
142− unrecord .
143− to .
144− fromGColumns @(TTable (Reify context)) @TColumns fromColumns
145−
146− default gtoColumns :: forall context.
147− ( Generic (Record (t (Reify context)))
148− , GColumns TColumns (Rep (Record (t (Reify context)))) ~ GRep t
149− , GTable (TTable (Reify context)) TColumns (Col (Reify context)) (Rep (Record (t (Reify context))))
150− )
151− => t (Reify context) -> GRep t (Col (Reify context))
152− gtoColumns =
153− toGColumns @(TTable (Reify context)) @TColumns toColumns .
154− from .
155− Record
156−
157− default greify :: forall context.
158− ( Generic (Record (t context))
159− , Generic (Record (t (Reify context)))
160− , GMappable (TTable (Reify context)) (Rep (Record (t (Reify context))))
161− , Rep (Record (t context)) ~ GMap TUnreify (Rep (Record (t (Reify context))))
162− )
163− => t context -> t (Reify context)
164− greify =
165− unrecord .
166− to .
167− gunmap @(TTable (Reify context)) (Proxy @TUnreify) (reify Refl) .
168− from .
169− Record
170−
171− default gunreify :: forall context.
172− ( Generic (Record (t context))
173− , Generic (Record (t (Reify context)))
174− , GMappable (TTable (Reify context)) (Rep (Record (t (Reify context))))
175− , Rep (Record (t context)) ~ GMap TUnreify (Rep (Record (t (Reify context))))
176− )
177− => t (Reify context) -> t context
178− gunreify =
179− unrecord .
180− to .
181− gmap @(TTable (Reify context)) (Proxy @TUnreify) (unreify Refl) .
182− from .
183− Record
src/Rel8/Schema/HKD.hsdeleted−318
@@ -1,318 +0,0 @@
1−{-# language AllowAmbiguousTypes #-}
2−{-# language BlockArguments #-}
3−{-# language ConstraintKinds #-}
4−{-# language DataKinds #-}
5−{-# language FlexibleContexts #-}
6−{-# language FlexibleInstances #-}
7−{-# language FunctionalDependencies #-}
8−{-# language GADTs #-}
9−{-# language LambdaCase #-}
10−{-# language QuantifiedConstraints #-}
11−{-# language PolyKinds #-}
12−{-# language RankNTypes #-}
13−{-# language ScopedTypeVariables #-}
14−{-# language StandaloneKindSignatures #-}
15−{-# language TypeApplications #-}
16−{-# language TypeFamilyDependencies #-}
17−{-# language TypeOperators #-}
18−{-# language UndecidableInstances #-}
19−{-# language UndecidableSuperClasses #-}
20−
21−{-# options -Wno-orphans #-}
22−
23−module Rel8.Schema.HKD
24− ( Lift
25− , HKDT(..)
26− ) where
27−
28−-- base
29−import Data.Functor.Compose ( Compose(..) )
30−import Data.Functor.Identity ( Identity(..), runIdentity )
31−import Data.Kind ( Constraint, Type )
32−import GHC.Generics
33− ( (:*:)( (:*:) ), K1( K1 ), M1( M1 ), C, D, S, Meta( MetaSel )
34− , Rep
35− )
36−import GHC.TypeLits ( KnownSymbol )
37−import Prelude
38−
39−-- higgledy
40−import Data.Generic.HKD ( Construct, HKD(..), GHKD_, construct, deconstruct )
41−
42−-- rel8
43−import Rel8.Aggregate ( Col(..), Aggregate )
44−import Rel8.Expr ( Expr )
45−import Rel8.Kind.Context ( Reifiable(..), SContext(..) )
46−import Rel8.Schema.Context.Label
47− ( Labelable
48− , HLabelable, hlabeler, hunlabeler
49− )
50−import Rel8.Schema.Dict ( Dict( Dict ) )
51−import Rel8.Schema.HTable ( HTable )
52−import Rel8.Schema.HTable.Label ( HLabel, hlabel, hunlabel )
53−import Rel8.Schema.HTable.Product ( HProduct( HProduct ) )
54−import Rel8.Schema.HTable.Type ( HType( HType ) )
55−import Rel8.Schema.Insert ( Insert, Col(..) )
56−import qualified Rel8.Schema.Kind as K
57−import Rel8.Schema.Name ( Name(..) )
58−import Rel8.Schema.Null ( Sql )
59−import Rel8.Schema.Reify ( Reify, hreify, hunreify, NotReify, notReify )
60−import Rel8.Schema.Result ( Result )
61−import Rel8.Table
62− ( Table, Columns, Context, fromColumns, toColumns
63− , Unreify, reify, unreify
64− )
65−import Rel8.Table.Recontextualize ( Recontextualize )
66−import Rel8.Table.Serialize ( FromExprs, ToExprs, fromResult, toResult )
67−import Rel8.Type ( DBType )
68−
69−
70−type Column1Helper :: K.Context -> (Type -> Type) -> Type -> Constraint
71−class
72− ( Table context (f a)
73− , Context1 f ~ context
74− , Context (f a) ~ context
75− , Columns (f a) ~ HType a
76− )
77− => Column1Helper context f a | f -> context
78−instance
79− ( Table context (f a)
80− , Context1 f ~ context
81− , Context (f a) ~ context
82− , Columns (f a) ~ HType a
83− )
84− => Column1Helper context f a
85−
86−
87−type Column1 :: K.Context -> (Type -> Type) -> Constraint
88−class
89− ( forall a. Sql DBType a => Column1Helper context f a
90− , Context1 f ~ context
91− ) =>
92− Column1 context f | f -> context
93−instance
94− ( forall a. Sql DBType a => Column1Helper context f a
95− , Context1 f ~ context
96− ) =>
97− Column1 context f
98−
99−
100−type Context1 :: (Type -> Type) -> K.Context
101−type Context1 f = Context (f Bool)
102−
103−
104−toColumn1 :: forall a f context. (Column1 context f, Sql DBType a)
105− => f a -> HType a (Col context)
106−toColumn1 = case Dict @(Column1Helper context f) @a of
107− Dict -> toColumns
108−
109−
110−fromColumn1 :: forall a f context. (Column1 context f, Sql DBType a)
111− => HType a (Col context) -> f a
112−fromColumn1 = case Dict @(Column1Helper context f) @a of
113− Dict -> fromColumns
114−
115−
116−type Recontextualize1
117− :: K.Context
118− -> K.Context
119− -> (Type -> Type)
120− -> (Type -> Type)
121− -> Constraint
122−class Recontextualize context context' (f Bool) (f' Bool) =>
123− Recontextualize1 context context' f f'
124−instance Recontextualize context context' (f Bool) (f' Bool) =>
125− Recontextualize1 context context' f f'
126−
127−
128−class HTable (GColumns rep) => GTable rep where
129− toGColumns :: HLabelable context
130− => (forall a. Sql DBType a => f a -> HType a context)
131− -> GHKD_ f rep x
132− -> GColumns rep context
133− fromGColumns :: HLabelable context
134− => (forall a. Sql DBType a => HType a context -> f a)
135− -> GColumns rep context
136− -> GHKD_ f rep x
137−
138−
139−instance GTable rep => GTable (M1 D c rep) where
140− toGColumns f (M1 a) = toGColumns f a
141− {-# INLINABLE toGColumns #-}
142−
143− fromGColumns f = M1 . fromGColumns f
144− {-# INLINABLE fromGColumns #-}
145−
146−
147−instance GTable rep => GTable (M1 C c rep) where
148− toGColumns f (M1 a) = toGColumns f a
149− {-# INLINABLE toGColumns #-}
150−
151− fromGColumns f = M1 . fromGColumns f
152− {-# INLINABLE fromGColumns #-}
153−
154−
155−instance (KnownSymbol name, Sql DBType a) =>
156− GTable (M1 S ('MetaSel ('Just name) _su _ss _ds) (K1 i a))
157− where
158− toGColumns f (M1 (K1 a)) = hlabel hlabeler (f a)
159− {-# INLINABLE toGColumns #-}
160−
161− fromGColumns f a = M1 (K1 (f (hunlabel hunlabeler a)))
162− {-# INLINABLE fromGColumns #-}
163−
164−
165−instance (GTable f, GTable g) => GTable (f :*: g) where
166− toGColumns f (x :*: y) = HProduct (toGColumns f x) (toGColumns f y)
167− {-# INLINABLE toGColumns #-}
168−
169− fromGColumns f (HProduct x y) = fromGColumns f x :*: fromGColumns f y
170− {-# INLINABLE fromGColumns #-}
171−
172−
173−type GRep a = GColumns (Rep a)
174−
175−
176−type GColumns :: (Type -> Type) -> K.HTable
177−type family GColumns rep where
178− GColumns (M1 D _ f) = GColumns f
179− GColumns (M1 C _ f) = GColumns f
180− GColumns (M1 S ('MetaSel ('Just name) _ _ _) (K1 _ a)) =
181− HLabel name (HType a)
182− GColumns (f :*: g) = HProduct (GColumns f) (GColumns g)
183−
184−
185−instance
186− ( GTable (Rep a)
187− , Column1 context f
188− , Labelable context
189− , NotReify context
190− )
191− => Table context (HKD a f)
192− where
193− type Columns (HKD a f) = GRep a
194− type Context (HKD a f) = Context1 f
195−
196− toColumns = toGColumns toColumn1 . runHKD
197− fromColumns = HKD . fromGColumns fromColumn1
198− reify = notReify
199− unreify = notReify
200−
201−
202−instance
203− ( a ~ a'
204− , GTable (Rep a)
205− , NotReify context, NotReify context'
206− , Recontextualize1 context context' f f'
207− , Column1 context f, Labelable context
208− , Column1 context' f', Labelable context'
209− ) =>
210− Recontextualize
211− context
212− context'
213− (HKD a f)
214− (HKD a' f')
215−
216−
217−type Lift :: K.Context -> Type -> Type
218−type family Lift context a where
219− Lift (Reify context) a = ALift context a
220− Lift Aggregate a = HKD a (Compose Aggregate Expr)
221− Lift Expr a = HKD a Expr
222− Lift Insert a = HKD a Expr
223− Lift Name a = HKD a Name
224− Lift Result a = a
225−
226−
227−type ALift :: K.Context -> Type -> Type
228−newtype ALift context a = ALift
229− { unALift :: Lift context a
230− }
231−
232−
233−instance
234− ( Reifiable context
235− , GTable (Rep a)
236− , Construct Identity a
237− )
238− => Table (Reify context) (ALift context a)
239− where
240− type Context (ALift context a) = Reify context
241− type Columns (ALift context a) = GRep a
242− type Unreify (ALift context a) = Lift context a
243−
244− fromColumns = sfromColumnsLift contextSing
245− toColumns = stoColumnsLift contextSing
246− reify _ = ALift
247− unreify _ (ALift a) = a
248−
249−
250−instance
251− ( Reifiable context
252− , Reifiable context'
253− , GTable (Rep a)
254− , Construct Identity a
255− )
256− => Recontextualize
257− (Reify context)
258− (Reify context')
259− (ALift context a)
260− (ALift context' a)
261−
262−
263−sfromColumnsLift :: forall a context. (GTable (Rep a), Construct Identity a)
264− => SContext context
265− -> GRep a (Col (Reify context))
266− -> ALift context a
267−sfromColumnsLift = \case
268− SAggregate ->
269− ALift .
270− HKD .
271− fromGColumns (\(HType (Aggregation a)) -> Compose a) .
272− hunreify
273− SExpr -> ALift . fromColumns . hunreify
274− SInsert ->
275− ALift .
276− HKD .
277− fromGColumns (\(HType (RequiredInsert a)) -> a) .
278− hunreify
279− SName -> ALift . fromColumns . hunreify
280− SResult -> ALift . runIdentity . construct . fromColumns . hunreify
281− SReify context -> ALift . sfromColumnsLift context . hunreify
282−
283−
284−stoColumnsLift :: forall a context. (GTable (Rep a), Construct Identity a)
285− => SContext context
286− -> ALift context a
287− -> GRep a (Col (Reify context))
288−stoColumnsLift = \case
289− SAggregate ->
290− hreify .
291− toGColumns (\(Compose a) -> HType (Aggregation a)) .
292− runHKD .
293− unALift
294− SExpr -> hreify . toColumns . unALift
295− SInsert ->
296− hreify .
297− toGColumns (HType . RequiredInsert) .
298− runHKD .
299− unALift
300− SName -> hreify . toColumns . unALift
301− SResult -> hreify . toColumns . deconstruct @Identity . unALift
302− SReify context -> hreify . stoColumnsLift context . unALift
303−
304−
305−type HKDT :: Type -> Type
306−newtype HKDT a = HKDT
307− { unHKDT :: a
308− }
309−
310−
311−instance (GTable (Rep a), Construct Identity a, x ~ HKD a Expr) =>
312− ToExprs x (HKDT a)
313− where
314− toResult = toColumns . deconstruct @Identity . unHKDT
315− fromResult = HKDT . runIdentity . construct . fromColumns
316−
317−
318−type instance FromExprs (HKD a Expr) = a
src/Rel8/Schema/HTable.hs+51−24
@@ -16,11 +16,12 @@
16module Rel8.Schema.HTable
16module Rel8.Schema.HTable
17 ( HTable (HField, HConstrainTable)
17 ( HTable (HField, HConstrainTable)
18 , hfield, htabulate, htraverse, hdicts, hspecs
18 , hfield, htabulate, htraverse, hdicts, hspecs
19− , hmap, htabulateA
19+ , hfoldMap, hmap, htabulateA, htraverseP, htraversePWithField
20 )
20 )
21where
21where
22
22
23-- base
23-- base
24+import Data.Functor.Const ( Const( Const ), getConst )
24import Data.Kind ( Constraint, Type )
25import Data.Kind ( Constraint, Type )
25import Data.Functor.Compose ( Compose( Compose ), getCompose )
26import Data.Functor.Compose ( Compose( Compose ), getCompose )
26import Data.Proxy ( Proxy )
27import Data.Proxy ( Proxy )
@@ -32,16 +33,21 @@ import GHC.Generics
32 )
33 )
33import Prelude
34import Prelude
34
35
36+-- profunctors
37+import Data.Profunctor ( rmap, Profunctor (lmap) )
38+
39+-- product-profunctors
40+import Data.Profunctor.Product ( ProductProfunctor ((****)) )
41+
35-- rel8
42-- rel8
36import Rel8.Schema.Dict ( Dict )
43import Rel8.Schema.Dict ( Dict )
37−import Rel8.Schema.Spec ( Spec, SSpec )
44+import Rel8.Schema.Spec ( Spec )
38import Rel8.Schema.HTable.Product ( HProduct( HProduct ) )
45import Rel8.Schema.HTable.Product ( HProduct( HProduct ) )
39import qualified Rel8.Schema.Kind as K
46import qualified Rel8.Schema.Kind as K
40
47
41-- semigroupoids
48-- semigroupoids
42import Data.Functor.Apply ( Apply, (<.>) )
49import Data.Functor.Apply ( Apply, (<.>) )
43
50
44−
45-- | A @HTable@ is a functor-indexed/higher-kinded data type that is
51-- | A @HTable@ is a functor-indexed/higher-kinded data type that is
46-- representable ('htabulate'/'hfield'), constrainable ('hdicts'), and
52-- representable ('htabulate'/'hfield'), constrainable ('hdicts'), and
47-- specified ('hspecs').
53-- specified ('hspecs').
@@ -50,14 +56,14 @@ import Data.Functor.Apply ( Apply, (<.>) )
50-- instances yourself or specify this constraint.
56-- instances yourself or specify this constraint.
51type HTable :: K.HTable -> Constraint
57type HTable :: K.HTable -> Constraint
52class HTable t where
58class HTable t where
53− type HField t = (field :: Spec -> Type) | field -> t
59+ type HField t = (field :: Type -> Type) | field -> t
54− type HConstrainTable t (c :: Spec -> Constraint) :: Constraint
60+ type HConstrainTable t (c :: Type -> Constraint) :: Constraint
55
61
56− hfield :: t context -> HField t spec -> context spec
62+ hfield :: t context -> HField t a -> context a
57− htabulate :: (forall spec. HField t spec -> context spec) -> t context
63+ htabulate :: (forall a. HField t a -> context a) -> t context
58− htraverse :: Apply m => (forall spec. f spec -> m (g spec)) -> t f -> m (t g)
64+ htraverse :: Apply m => (forall a. f a -> m (g a)) -> t f -> m (t g)
59 hdicts :: HConstrainTable t c => t (Dict c)
65 hdicts :: HConstrainTable t c => t (Dict c)
60− hspecs :: t SSpec
66+ hspecs :: t Spec
61
67
62 type HField t = GHField t
68 type HField t = GHField t
63 type HConstrainTable t c = HConstrainTable (GHColumns (Rep (t Proxy))) c
69 type HConstrainTable t c = HConstrainTable (GHColumns (Rep (t Proxy))) c
@@ -68,7 +74,7 @@ class HTable t where
68 , HField (GHColumns (Rep (t Proxy))) ~ HField (GHColumns (Rep (t context)))
74 , HField (GHColumns (Rep (t Proxy))) ~ HField (GHColumns (Rep (t context)))
69 , GHTable context (Rep (t context))
75 , GHTable context (Rep (t context))
70 )
76 )
71− => t context -> HField t spec -> context spec
77+ => t context -> HField t a -> context a
72 hfield table (GHField field) = hfield (toGHColumns (from table)) field
78 hfield table (GHField field) = hfield (toGHColumns (from table)) field
73
79
74 default htabulate ::
80 default htabulate ::
@@ -77,7 +83,7 @@ class HTable t where
77 , HField (GHColumns (Rep (t Proxy))) ~ HField (GHColumns (Rep (t context)))
83 , HField (GHColumns (Rep (t Proxy))) ~ HField (GHColumns (Rep (t context)))
78 , GHTable context (Rep (t context))
84 , GHTable context (Rep (t context))
79 )
85 )
80− => (forall spec. HField t spec -> context spec) -> t context
86+ => (forall a. HField t a -> context a) -> t context
81 htabulate f = to $ fromGHColumns $ htabulate (f . GHField)
87 htabulate f = to $ fromGHColumns $ htabulate (f . GHField)
82
88
83 default htraverse
89 default htraverse
@@ -87,7 +93,7 @@ class HTable t where
87 , Generic (t g), GHTable g (Rep (t g))
93 , Generic (t g), GHTable g (Rep (t g))
88 , GHColumns (Rep (t f)) ~ GHColumns (Rep (t g))
94 , GHColumns (Rep (t f)) ~ GHColumns (Rep (t g))
89 )
95 )
90− => (forall spec. f spec -> m (g spec)) -> t f -> m (t g)
96+ => (forall a. f a -> m (g a)) -> t f -> m (t g)
91 htraverse f = fmap (to . fromGHColumns) . htraverse f . toGHColumns . from
97 htraverse f = fmap (to . fromGHColumns) . htraverse f . toGHColumns . from
92
98
93 default hdicts
99 default hdicts
@@ -101,10 +107,10 @@ class HTable t where
101 hdicts = to $ fromGHColumns (hdicts @(GHColumns (Rep (t Proxy))) @c)
107 hdicts = to $ fromGHColumns (hdicts @(GHColumns (Rep (t Proxy))) @c)
102
108
103 default hspecs ::
109 default hspecs ::
104− ( Generic (t SSpec)
110+ ( Generic (t Spec)
105− , GHTable SSpec (Rep (t SSpec))
111+ , GHTable Spec (Rep (t Spec))
106 )
112 )
107− => t SSpec
113+ => t Spec
108 hspecs = to $ fromGHColumns hspecs
114 hspecs = to $ fromGHColumns hspecs
109
115
110 {-# INLINABLE hfield #-}
116 {-# INLINABLE hfield #-}
@@ -114,22 +120,43 @@ class HTable t where
114 {-# INLINABLE hspecs #-}
120 {-# INLINABLE hspecs #-}
115
121
116
122
123+hfoldMap :: (HTable t, Semigroup s)
124+ => (forall a. context a -> s) -> t context -> s
125+hfoldMap f a = getConst $ htraverse (Const . f) a
126+
127+
117hmap :: HTable t
128hmap :: HTable t
118− => (forall spec. context spec -> context' spec) -> t context -> t context'
129+ => (forall a. context a -> context' a) -> t context -> t context'
119hmap f a = htabulate $ \field -> f (hfield a field)
130hmap f a = htabulate $ \field -> f (hfield a field)
120
131
121
132
122htabulateA :: (HTable t, Apply m)
133htabulateA :: (HTable t, Apply m)
123− => (forall spec. HField t spec -> m (context spec)) -> m (t context)
134+ => (forall a. HField t a -> m (context a)) -> m (t context)
124htabulateA f = htraverse getCompose $ htabulate $ Compose . f
135htabulateA f = htraverse getCompose $ htabulate $ Compose . f
125{-# INLINABLE htabulateA #-}
136{-# INLINABLE htabulateA #-}
126
137
138+newtype ApplyP p a b = ApplyP { unApplyP :: p a b }
139+
140+instance Profunctor p => Functor (ApplyP p a) where
141+ fmap f = ApplyP . rmap f . unApplyP
142+
143+instance ProductProfunctor p => Apply (ApplyP p a) where
144+ ApplyP f <.> ApplyP x = ApplyP (rmap id f **** x)
145+
146+htraverseP :: (HTable t, ProductProfunctor p)
147+ => (forall a. p (f a) (g a)) -> p (t f) (t g)
148+htraverseP f = htraversePWithField (const f)
149+
150+htraversePWithField :: (HTable t, ProductProfunctor p)
151+ => (forall a. HField t a -> p (f a) (g a)) -> p (t f) (t g)
152+htraversePWithField f = unApplyP $ htabulateA $ \field -> ApplyP $
153+ lmap (flip hfield field) (f field)
127
154
128−type GHField :: K.HTable -> Spec -> Type
155+type GHField :: K.HTable -> Type -> Type
129−newtype GHField t spec = GHField (HField (GHColumns (Rep (t Proxy))) spec)
156+newtype GHField t a = GHField (HField (GHColumns (Rep (t Proxy))) a)
130
157
131
158
132−type GHTable :: K.HContext -> (Type -> Type) -> Constraint
159+type GHTable :: K.Context -> (Type -> Type) -> Constraint
133class HTable (GHColumns rep) => GHTable context rep | rep -> context where
160class HTable (GHColumns rep) => GHTable context rep | rep -> context where
134 type GHColumns rep :: K.HTable
161 type GHColumns rep :: K.HTable
135 toGHColumns :: rep x -> GHColumns rep context
162 toGHColumns :: rep x -> GHColumns rep context
@@ -155,10 +182,10 @@ instance (GHTable context a, GHTable context b) => GHTable context (a :*: b) whe
155
182
156
183
157-- | A HField type for indexing into HProduct.
184-- | A HField type for indexing into HProduct.
158−type HProductField :: K.HTable -> K.HTable -> Spec -> Type
185+type HProductField :: K.HTable -> K.HTable -> Type -> Type
159−data HProductField x y spec
186+data HProductField x y a
160− = HFst (HField x spec)
187+ = HFst (HField x a)
161− | HSnd (HField y spec)
188+ | HSnd (HField y a)
162
189
163
190
164instance (HTable x, HTable y) => HTable (HProduct x y) where
191instance (HTable x, HTable y) => HTable (HProduct x y) where
src/Rel8/Schema/HTable/Either.hs+2−4
@@ -14,19 +14,17 @@ import GHC.Generics ( Generic )
14import Prelude ()
14import Prelude ()
15
15
16-- rel8
16-- rel8
17−import Rel8.Kind.Necessity ( Necessity( Required ) )
18import Rel8.Schema.HTable ( HTable )
17import Rel8.Schema.HTable ( HTable )
19−import Rel8.Schema.HTable.Identity ( HIdentity(..) )
18+import Rel8.Schema.HTable.Identity ( HIdentity )
20import Rel8.Schema.HTable.Label ( HLabel )
19import Rel8.Schema.HTable.Label ( HLabel )
21import Rel8.Schema.HTable.Nullify ( HNullify )
20import Rel8.Schema.HTable.Nullify ( HNullify )
22import qualified Rel8.Schema.Kind as K
21import qualified Rel8.Schema.Kind as K
23−import Rel8.Schema.Spec ( Spec( Spec ) )
24import Rel8.Type.Tag ( EitherTag )
22import Rel8.Type.Tag ( EitherTag )
25
23
26
24
27type HEitherTable :: K.HTable -> K.HTable -> K.HTable
25type HEitherTable :: K.HTable -> K.HTable -> K.HTable
28data HEitherTable left right context = HEitherTable
26data HEitherTable left right context = HEitherTable
29− { htag :: HIdentity ('Spec '["isRight"] 'Required EitherTag) context
27+ { htag :: HLabel "isRight" (HIdentity EitherTag) context
30 , hleft :: HLabel "Left" (HNullify left) context
28 , hleft :: HLabel "Left" (HNullify left) context
31 , hright :: HLabel "Right" (HNullify right) context
29 , hright :: HLabel "Right" (HNullify right) context
32 }
30 }
src/Rel8/Schema/HTable/Identity.hs+16−17
@@ -1,15 +1,17 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2−{-# language GADTs #-}
2+{-# language FlexibleContexts #-}
3{-# language StandaloneKindSignatures #-}
3{-# language StandaloneKindSignatures #-}
4{-# language TypeFamilies #-}
4{-# language TypeFamilies #-}
5+{-# language UndecidableInstances #-}
5
6
6module Rel8.Schema.HTable.Identity
7module Rel8.Schema.HTable.Identity
7− ( HIdentity(..)
8+ ( HIdentity( HIdentity, unHIdentity )
8 )
9 )
9where
10where
10
11
11-- base
12-- base
12import Data.Kind ( Type )
13import Data.Kind ( Type )
14+import Data.Type.Equality ( (:~:)( Refl ) )
13import Prelude
15import Prelude
14
16
15-- rel8
17-- rel8
@@ -19,26 +21,23 @@ import Rel8.Schema.HTable
19 , hfield, htabulate, htraverse, hdicts, hspecs
21 , hfield, htabulate, htraverse, hdicts, hspecs
20 )
22 )
21import qualified Rel8.Schema.Kind as K
23import qualified Rel8.Schema.Kind as K
22−import Rel8.Schema.Spec ( Spec, KnownSpec, specSing )
24+import Rel8.Schema.Null ( Sql )
25+import Rel8.Schema.Spec ( specification )
26+import Rel8.Type ( DBType )
23
27
24
28
25−type HIdentity :: Spec -> K.HTable
29+type HIdentity :: Type -> K.HTable
26−newtype HIdentity spec context = HIdentity
30+newtype HIdentity a context = HIdentity
27− { unHIdentity :: context spec
31+ { unHIdentity :: context a
28 }
32 }
29
33
30
34
31−type HIdentityField :: Spec -> Spec -> Type
35+instance Sql DBType a => HTable (HIdentity a) where
32−data HIdentityField _spec spec where
36+ type HConstrainTable (HIdentity a) constraint = constraint a
33− HIdentityField :: HIdentityField spec spec
37+ type HField (HIdentity a) = (:~:) a
34
38
35−
39+ hfield (HIdentity a) Refl = a
36−instance KnownSpec spec => HTable (HIdentity spec) where
40+ htabulate f = HIdentity $ f Refl
37− type HConstrainTable (HIdentity spec) c = c spec
38− type HField (HIdentity spec) = HIdentityField spec
39−
40− hfield (HIdentity a) HIdentityField = a
41− htabulate f = HIdentity $ f HIdentityField
42 htraverse f (HIdentity a) = HIdentity <$> f a
41 htraverse f (HIdentity a) = HIdentity <$> f a
43 hdicts = HIdentity Dict
42 hdicts = HIdentity Dict
44− hspecs = HIdentity specSing
43+ hspecs = HIdentity specification
src/Rel8/Schema/HTable/Label.hs+37−50
@@ -1,83 +1,70 @@
1−{-# LANGUAGE DeriveAnyClass #-}
2−{-# LANGUAGE DeriveGeneric #-}
3−{-# LANGUAGE DerivingStrategies #-}
4−{-# LANGUAGE LambdaCase #-}
5−{-# language ConstraintKinds #-}
6{-# language DataKinds #-}
1{-# language DataKinds #-}
7−{-# language FlexibleInstances #-}
8−{-# language GADTs #-}
9−{-# language MultiParamTypeClasses #-}
10−{-# language QuantifiedConstraints #-}
11{-# language RankNTypes #-}
2{-# language RankNTypes #-}
12{-# language RecordWildCards #-}
3{-# language RecordWildCards #-}
13{-# language ScopedTypeVariables #-}
4{-# language ScopedTypeVariables #-}
14{-# language StandaloneKindSignatures #-}
5{-# language StandaloneKindSignatures #-}
6+{-# language TypeApplications #-}
15{-# language TypeFamilies #-}
7{-# language TypeFamilies #-}
16−{-# language TypeOperators #-}
17−{-# language UndecidableInstances #-}
18
8
19module Rel8.Schema.HTable.Label
9module Rel8.Schema.HTable.Label
20− ( HLabel, Label
10+ ( HLabel, hlabel, hrelabel, hunlabel
21− , hlabel, hunlabel
11+ , hproject
22 )
12 )
23where
13where
24
14
25-- base
15-- base
16+import Data.Kind ( Type )
26import Data.Proxy ( Proxy( Proxy ) )
17import Data.Proxy ( Proxy( Proxy ) )
27−import GHC.TypeLits ( KnownSymbol, Symbol )
18+import GHC.TypeLits ( KnownSymbol, Symbol, symbolVal )
28import Prelude
19import Prelude
29
20
30-- rel8
21-- rel8
31−import Rel8.Kind.Labels ( SLabels( SLabels ) )
32import Rel8.Schema.HTable
22import Rel8.Schema.HTable
33− ( HTable
23+ ( HTable, HConstrainTable, HField
34− , hfield, htabulate, hspecs
24+ , htabulate, hfield, htraverse, hdicts, hspecs
35 )
25 )
36import qualified Rel8.Schema.Kind as K
26import qualified Rel8.Schema.Kind as K
37−import Rel8.Schema.Spec ( Spec( Spec ), SSpec(..) )
27+import Rel8.Schema.Spec ( Spec(..) )
38−import Rel8.FCF
39−import Rel8.Schema.HTable.MapTable
40−import GHC.Generics (Generic)
41
28
42
29
43type HLabel :: Symbol -> K.HTable -> K.HTable
30type HLabel :: Symbol -> K.HTable -> K.HTable
44−newtype HLabel label table context = HLabel (HMapTable (Label label) table context)
31+newtype HLabel label table context = HLabel (table context)
45− deriving stock Generic
46− deriving anyclass HTable
47
32
48
33
49−data Label :: Symbol -> Spec -> Exp Spec
34+type HLabelField :: Symbol -> K.HTable -> Type -> Type
35+newtype HLabelField label table a = HLabelField (HField table a)
50
36
51
37
52−type instance Eval (Label label ('Spec labels necessity a)) = 'Spec (label : labels) necessity a
38+instance (HTable table, KnownSymbol label) => HTable (HLabel label table) where
39+ type HField (HLabel label table) = HLabelField label table
40+ type HConstrainTable (HLabel label table) constraint =
41+ HConstrainTable table constraint
53
42
43+ hfield (HLabel a) (HLabelField field) = hfield a field
44+ htabulate f = HLabel (htabulate (f . HLabelField))
45+ htraverse f (HLabel a) = HLabel <$> htraverse f a
46+ hdicts = HLabel (hdicts @table)
47+ hspecs = HLabel $ htabulate $ \field -> case hfield (hspecs @table) field of
48+ Spec {..} -> Spec {labels = symbolVal (Proxy @label) : labels, ..}
49+ {-# INLINABLE hspecs #-}
54
50
55−instance KnownSymbol l => MapSpec (Label l) where
56− mapInfo = \case
57− SSpec {..} -> SSpec {labels = SLabels Proxy labels, ..}
58
51
59−
52+hlabel :: forall label t context. t context -> HLabel label t context
60−hlabel :: (HTable t, KnownSymbol label)
53+hlabel = HLabel
61− => (forall labels necessity a. ()
62− => context ('Spec labels necessity a)
63− -> context ('Spec (label ': labels) necessity a))
64− -> t context
65− -> HLabel label t context
66−hlabel labeler a = HLabel $ htabulate $ \(HMapTableField field) ->
67− case hfield hspecs field of
68− SSpec {} -> labeler (hfield a field)
69{-# INLINABLE hlabel #-}
54{-# INLINABLE hlabel #-}
70
55
71
56
72−hunlabel :: (HTable t, KnownSymbol label)
57+hrelabel :: forall label' label t context. HLabel label t context -> HLabel label' t context
73− => (forall labels necessity a. ()
58+hrelabel = hlabel . hunlabel
74− => context ('Spec (label ': labels) necessity a)
59+{-# INLINABLE hrelabel #-}
75− -> context ('Spec labels necessity a))
60+
76− -> HLabel label t context
61+
77− -> t context
62+hunlabel :: forall label t context. HLabel label t context -> t context
78−hunlabel unlabler (HLabel as) =
63+hunlabel (HLabel a) = a
79− htabulate $ \field ->
80− case hfield hspecs field of
81− SSpec {} -> case hfield as (HMapTableField field) of
82− a -> unlabler a
83{-# INLINABLE hunlabel #-}
64{-# INLINABLE hunlabel #-}
65+
66+
67+hproject :: ()
68+ => (forall ctx. t ctx -> t' ctx)
69+ -> HLabel label t context -> HLabel label t' context
70+hproject f (HLabel a) = HLabel (f a)
src/Rel8/Schema/HTable/MapTable.hs+22−12
@@ -6,7 +6,7 @@
6{-# language GADTs #-}
6{-# language GADTs #-}
7{-# language InstanceSigs #-}
7{-# language InstanceSigs #-}
8{-# language MultiParamTypeClasses #-}
8{-# language MultiParamTypeClasses #-}
9−{-# language PolyKinds #-}
9+{-# language RankNTypes #-}
10{-# language ScopedTypeVariables #-}
10{-# language ScopedTypeVariables #-}
11{-# language StandaloneKindSignatures #-}
11{-# language StandaloneKindSignatures #-}
12{-# language TypeApplications #-}
12{-# language TypeApplications #-}
@@ -19,34 +19,38 @@ module Rel8.Schema.HTable.MapTable
19 , MapSpec(..)
19 , MapSpec(..)
20 , Precompose(..)
20 , Precompose(..)
21 , HMapTableField(..)
21 , HMapTableField(..)
22+ , hproject
22 )
23 )
23where
24where
24
25
25-- base
26-- base
26import Data.Kind ( Constraint, Type )
27import Data.Kind ( Constraint, Type )
27−import Prelude ( ($), (.), (<$>), fmap )
28+import Prelude
28
29
29-- rel8
30-- rel8
30−import Rel8.FCF
31+import Rel8.FCF ( Exp, Eval )
31import Rel8.Schema.HTable
32import Rel8.Schema.HTable
32−import Rel8.Schema.Spec ( Spec, SSpec )
33+ ( HTable, HConstrainTable, HField
34+ , hfield, htabulate, htraverse, hdicts, hspecs
35+ )
36+import Rel8.Schema.Spec ( Spec )
33import qualified Rel8.Schema.Kind as K
37import qualified Rel8.Schema.Kind as K
34import Rel8.Schema.Dict ( Dict( Dict ) )
38import Rel8.Schema.Dict ( Dict( Dict ) )
35
39
36
40
37−type HMapTable :: (a -> Exp b) -> ((a -> Type) -> Type) -> (b -> Type) -> Type
41+type HMapTable :: (Type -> Exp Type) -> K.HTable -> K.HTable
38−newtype HMapTable f t g = HMapTable
42+newtype HMapTable f t context = HMapTable
39− { unHMapTable :: t (Precompose f g)
43+ { unHMapTable :: t (Precompose f context)
40 }
44 }
41
45
42
46
43−type Precompose :: (a -> Exp b) -> (b -> Type) -> a -> Type
47+type Precompose :: (Type -> Exp Type) -> K.Context -> K.Context
44newtype Precompose f g x = Precompose
48newtype Precompose f g x = Precompose
45 { precomposed :: g (Eval (f x))
49 { precomposed :: g (Eval (f x))
46 }
50 }
47
51
48
52
49−type HMapTableField :: (Spec -> Exp a) -> K.HTable -> a -> Type
53+type HMapTableField :: (Type -> Exp Type) -> K.HTable -> K.Context
50data HMapTableField f t x where
54data HMapTableField f t x where
51 HMapTableField :: HField t a -> HMapTableField f t (Eval (f a))
55 HMapTableField :: HField t a -> HMapTableField f t (Eval (f a))
52
56
@@ -79,11 +83,17 @@ instance (HTable t, MapSpec f) => HTable (HMapTable f t) where
79 {-# INLINABLE hspecs #-}
83 {-# INLINABLE hspecs #-}
80
84
81
85
82−type MapSpec :: (Spec -> Exp Spec) -> Constraint
86+type MapSpec :: (Type -> Exp Type) -> Constraint
83class MapSpec f where
87class MapSpec f where
84− mapInfo :: SSpec x -> SSpec (Eval (f x))
88+ mapInfo :: Spec x -> Spec (Eval (f x))
85
89
86
90
87−type ComposeConstraint :: (a -> Exp b) -> (b -> Constraint) -> a -> Constraint
91+type ComposeConstraint :: (Type -> Exp Type) -> (Type -> Constraint) -> Type -> Constraint
88class c (Eval (f a)) => ComposeConstraint f c a
92class c (Eval (f a)) => ComposeConstraint f c a
89instance c (Eval (f a)) => ComposeConstraint f c a
93instance c (Eval (f a)) => ComposeConstraint f c a
94+
95+
96+hproject :: ()
97+ => (forall ctx. t ctx -> t' ctx)
98+ -> HMapTable f t context -> HMapTable f t' context
99+hproject f (HMapTable a) = HMapTable (f a)
src/Rel8/Schema/HTable/Maybe.hs+2−4
@@ -14,19 +14,17 @@ import GHC.Generics ( Generic )
14import Prelude
14import Prelude
15
15
16-- rel8
16-- rel8
17−import Rel8.Kind.Necessity ( Necessity( Required ) )
18import Rel8.Schema.HTable ( HTable )
17import Rel8.Schema.HTable ( HTable )
19−import Rel8.Schema.HTable.Identity ( HIdentity(..) )
18+import Rel8.Schema.HTable.Identity ( HIdentity )
20import Rel8.Schema.HTable.Label ( HLabel )
19import Rel8.Schema.HTable.Label ( HLabel )
21import Rel8.Schema.HTable.Nullify ( HNullify )
20import Rel8.Schema.HTable.Nullify ( HNullify )
22import qualified Rel8.Schema.Kind as K
21import qualified Rel8.Schema.Kind as K
23−import Rel8.Schema.Spec ( Spec( Spec ) )
24import Rel8.Type.Tag ( MaybeTag )
22import Rel8.Type.Tag ( MaybeTag )
25
23
26
24
27type HMaybeTable :: K.HTable -> K.HTable
25type HMaybeTable :: K.HTable -> K.HTable
28data HMaybeTable table context = HMaybeTable
26data HMaybeTable table context = HMaybeTable
29− { htag :: HIdentity ('Spec '["isJust"] 'Required (Maybe MaybeTag)) context
27+ { htag :: HLabel "isJust" (HIdentity (Maybe MaybeTag)) context
30 , hjust :: HLabel "Just" (HNullify table) context
28 , hjust :: HLabel "Just" (HNullify table) context
31 }
29 }
32 deriving stock Generic
30 deriving stock Generic
src/Rel8/Schema/HTable/Nullify.hs+47−32
@@ -10,6 +10,7 @@
10{-# language NamedFieldPuns #-}
10{-# language NamedFieldPuns #-}
11{-# language QuantifiedConstraints #-}
11{-# language QuantifiedConstraints #-}
12{-# language RankNTypes #-}
12{-# language RankNTypes #-}
13+{-# language RecordWildCards #-}
13{-# language ScopedTypeVariables #-}
14{-# language ScopedTypeVariables #-}
14{-# language StandaloneKindSignatures #-}
15{-# language StandaloneKindSignatures #-}
15{-# language TypeFamilies #-}
16{-# language TypeFamilies #-}
@@ -18,25 +19,34 @@
18module Rel8.Schema.HTable.Nullify
19module Rel8.Schema.HTable.Nullify
19 ( HNullify( HNullify )
20 ( HNullify( HNullify )
20 , Nullify
21 , Nullify
21− , hnulls, hnullify, hunnullify
22+ , hguard
23+ , hnulls
24+ , hnullify
25+ , hunnullify
26+ , hproject
22 )
27 )
23where
28where
24
29
25-- base
30-- base
31+import Data.Kind ( Type )
32+import GHC.Generics ( Generic )
26import Prelude hiding ( null )
33import Prelude hiding ( null )
27
34
28-- rel8
35-- rel8
36+import Rel8.FCF ( Eval, Exp )
29import Rel8.Schema.HTable ( HTable, hfield, htabulate, htabulateA, hspecs )
37import Rel8.Schema.HTable ( HTable, hfield, htabulate, htabulateA, hspecs )
38+import Rel8.Schema.HTable.MapTable
39+ ( HMapTable, HMapTableField( HMapTableField )
40+ , MapSpec, mapInfo
41+ )
42+import qualified Rel8.Schema.HTable.MapTable as HMapTable ( hproject )
30import qualified Rel8.Schema.Kind as K
43import qualified Rel8.Schema.Kind as K
31import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
44import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
32import qualified Rel8.Schema.Null as Type ( Nullify )
45import qualified Rel8.Schema.Null as Type ( Nullify )
33−import Rel8.Schema.Spec ( Spec( Spec ), SSpec(..) )
46+import Rel8.Schema.Spec ( Spec(..) )
34
47
35-- semigroupoids
48-- semigroupoids
36import Data.Functor.Apply ( Apply )
49import Data.Functor.Apply ( Apply )
37−import Rel8.Schema.HTable.MapTable
38−import Rel8.FCF
39−import GHC.Generics (Generic)
40
50
41
51
42type HNullify :: K.HTable -> K.HTable
52type HNullify :: K.HTable -> K.HTable
@@ -45,58 +55,63 @@ newtype HNullify table context = HNullify (HMapTable Nullify table context)
45 deriving anyclass HTable
55 deriving anyclass HTable
46
56
47
57
48−
58+-- | Transform a 'Type' by allowing it to be @null@.
49−-- | Transform a 'Spec' by allowing it to be @null@.
59+data Nullify :: Type -> Exp Type
50−data Nullify :: Spec -> Exp Spec
60+type instance Eval (Nullify a) = Type.Nullify a
51−
52−
53−type instance Eval (Nullify ('Spec labels necessity a)) =
54− 'Spec labels necessity (Type.Nullify a)
55
61
56
62
57instance MapSpec Nullify where
63instance MapSpec Nullify where
58 mapInfo = \case
64 mapInfo = \case
59− SSpec{labels, necessity, info, nullity} -> SSpec
65+ Spec {nullity, ..} -> Spec
60− { labels
66+ { nullity = case nullity of
61− , necessity
62− , info
63− , nullity = case nullity of
64 Null -> Null
67 Null -> Null
65 NotNull -> Null
68 NotNull -> Null
66− }
69+ , ..
70+ }
71+
72+
73+hguard :: HTable t
74+ => (forall a. context (Maybe a) -> context (Maybe a))
75+ -> HNullify t context -> HNullify t context
76+hguard guarder (HNullify as) = HNullify $ htabulate $ \(HMapTableField field) ->
77+ case hfield hspecs field of
78+ Spec {nullity} -> case hfield as (HMapTableField field) of
79+ a -> case nullity of
80+ Null -> guarder a
81+ NotNull -> guarder a
67
82
68
83
69hnulls :: HTable t
84hnulls :: HTable t
70− => (forall labels necessity a. ()
85+ => (forall a. Spec a -> context (Type.Nullify a))
71− => context ('Spec labels necessity (Maybe a)))
72 -> HNullify t context
86 -> HNullify t context
73−hnulls null = HNullify $ htabulate $ \(HMapTableField field) -> case hfield hspecs field of
87+hnulls null = HNullify $ htabulate $ \(HMapTableField field) ->
74− SSpec {} -> null
88+ case hfield hspecs field of
89+ spec@Spec {} -> null spec
75{-# INLINABLE hnulls #-}
90{-# INLINABLE hnulls #-}
76
91
77
92
78hnullify :: HTable t
93hnullify :: HTable t
79− => (forall labels necessity a. ()
94+ => (forall a. Spec a -> context a -> context (Type.Nullify a))
80− => SSpec ('Spec labels necessity a)
81− -> context ('Spec labels necessity a)
82− -> context ('Spec labels necessity (Type.Nullify a)))
83 -> t context
95 -> t context
84 -> HNullify t context
96 -> HNullify t context
85hnullify nullifier a = HNullify $ htabulate $ \(HMapTableField field) ->
97hnullify nullifier a = HNullify $ htabulate $ \(HMapTableField field) ->
86 case hfield hspecs field of
98 case hfield hspecs field of
87− spec@SSpec {} -> nullifier spec (hfield a field)
99+ spec@Spec {} -> nullifier spec (hfield a field)
88{-# INLINABLE hnullify #-}
100{-# INLINABLE hnullify #-}
89
101
90
102
91hunnullify :: (HTable t, Apply m)
103hunnullify :: (HTable t, Apply m)
92− => (forall labels necessity a. ()
104+ => (forall a. Spec a -> context (Type.Nullify a) -> m (context a))
93− => SSpec ('Spec labels necessity a)
94− -> context ('Spec labels necessity (Type.Nullify a))
95− -> m (context ('Spec labels necessity a)))
96 -> HNullify t context
105 -> HNullify t context
97 -> m (t context)
106 -> m (t context)
98hunnullify unnullifier (HNullify as) =
107hunnullify unnullifier (HNullify as) =
99 htabulateA $ \field -> case hfield hspecs field of
108 htabulateA $ \field -> case hfield hspecs field of
100− spec@SSpec {} -> case hfield as (HMapTableField field) of
109+ spec@Spec {} -> case hfield as (HMapTableField field) of
101 a -> unnullifier spec a
110 a -> unnullifier spec a
102{-# INLINABLE hunnullify #-}
111{-# INLINABLE hunnullify #-}
112+
113+
114+hproject :: ()
115+ => (forall ctx. t ctx -> t' ctx)
116+ -> HNullify t context -> HNullify t' context
117+hproject f (HNullify a) = HNullify (HMapTable.hproject f a)
src/Rel8/Schema/HTable/These.hs+2−4
@@ -14,21 +14,19 @@ import GHC.Generics ( Generic )
14import Prelude
14import Prelude
15
15
16-- rel8
16-- rel8
17−import Rel8.Kind.Necessity ( Necessity( Required ) )
18import Rel8.Schema.HTable ( HTable )
17import Rel8.Schema.HTable ( HTable )
19import Rel8.Schema.HTable.Identity ( HIdentity )
18import Rel8.Schema.HTable.Identity ( HIdentity )
20import Rel8.Schema.HTable.Label ( HLabel )
19import Rel8.Schema.HTable.Label ( HLabel )
21import Rel8.Schema.HTable.Nullify ( HNullify )
20import Rel8.Schema.HTable.Nullify ( HNullify )
22import qualified Rel8.Schema.Kind as K
21import qualified Rel8.Schema.Kind as K
23−import Rel8.Schema.Spec ( Spec( Spec ) )
24import Rel8.Type.Tag ( MaybeTag )
22import Rel8.Type.Tag ( MaybeTag )
25
23
26
24
27type HTheseTable :: K.HTable -> K.HTable -> K.HTable
25type HTheseTable :: K.HTable -> K.HTable -> K.HTable
28data HTheseTable here there context = HTheseTable
26data HTheseTable here there context = HTheseTable
29− { hhereTag :: HIdentity ('Spec '["hasHere"] 'Required (Maybe MaybeTag)) context
27+ { hhereTag :: HLabel "hereTag" (HIdentity (Maybe MaybeTag)) context
30 , hhere :: HLabel "Here" (HNullify here) context
28 , hhere :: HLabel "Here" (HNullify here) context
31− , hthereTag :: HIdentity ('Spec '["hasThere"] 'Required (Maybe MaybeTag)) context
29+ , hthereTag :: HLabel "thereTag" (HIdentity (Maybe MaybeTag)) context
32 , hthere :: HLabel "There" (HNullify there) context
30 , hthere :: HLabel "There" (HNullify there) context
33 }
31 }
34 deriving stock Generic
32 deriving stock Generic
src/Rel8/Schema/HTable/Type.hsdeleted−61
@@ -1,61 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language GADTs #-}
3−{-# language StandaloneKindSignatures #-}
4−{-# language TypeFamilies #-}
5−{-# language UndecidableInstances #-}
6−
7−module Rel8.Schema.HTable.Type
8− ( HType(..)
9− )
10−where
11−
12−-- base
13−import Data.Kind ( Type )
14−import Data.Proxy ( Proxy( Proxy ) )
15−import Prelude
16−
17−-- rel8
18−import Rel8.Kind.Labels ( SLabels( SLabel ) )
19−import Rel8.Kind.Necessity ( Necessity( Required ), SNecessity( SRequired ) )
20−import Rel8.Schema.Dict ( Dict( Dict ) )
21−import Rel8.Schema.HTable
22− ( HTable, HConstrainTable, HField
23− , hfield, htabulate, htraverse, hdicts, hspecs
24− )
25−import qualified Rel8.Schema.Kind as K
26−import Rel8.Schema.Null ( Sql, nullable )
27−import Rel8.Schema.Spec ( Spec( Spec ), SSpec(..) )
28−import Rel8.Type ( DBType, typeInformation )
29−
30−
31−type HType :: Type -> K.HTable
32−newtype HType a context = HType
33− { unHType :: context ('Spec '[""] 'Required a)
34− }
35−
36−
37−type HTypeField :: Type -> Spec -> Type
38−data HTypeField a spec where
39− HTypeField :: HTypeField a ('Spec '[""] 'Required a)
40−
41−
42−instance Sql DBType a => HTable (HType a) where
43− type HConstrainTable (HType a) c = c ('Spec '[""] 'Required a)
44− type HField (HType a) = HTypeField a
45−
46− hfield (HType a) HTypeField = a
47− htabulate f = HType $ f HTypeField
48− htraverse f (HType a) = HType <$> f a
49− hdicts = HType Dict
50− hspecs = HType SSpec
51− { labels = SLabel Proxy
52− , necessity = SRequired
53− , info = typeInformation
54− , nullity = nullable
55− }
56−
57− {-# INLINABLE hfield #-}
58− {-# INLINABLE htabulate #-}
59− {-# INLINABLE htraverse #-}
60− {-# INLINABLE hdicts #-}
61− {-# INLINABLE hspecs #-}
src/Rel8/Schema/HTable/Vectorize.hs+39−47
@@ -9,8 +9,6 @@
9{-# language GADTs #-}
9{-# language GADTs #-}
10{-# language LambdaCase #-}
10{-# language LambdaCase #-}
11{-# language MultiParamTypeClasses #-}
11{-# language MultiParamTypeClasses #-}
12−{-# language NamedFieldPuns #-}
13−{-# language QuantifiedConstraints #-}
14{-# language RankNTypes #-}
12{-# language RankNTypes #-}
15{-# language RecordWildCards #-}
13{-# language RecordWildCards #-}
16{-# language ScopedTypeVariables #-}
14{-# language ScopedTypeVariables #-}
@@ -23,34 +21,39 @@ module Rel8.Schema.HTable.Vectorize
23 ( HVectorize
21 ( HVectorize
24 , hvectorize, hunvectorize
22 , hvectorize, hunvectorize
25 , happend, hempty
23 , happend, hempty
24+ , hproject
25+ , hcolumn
26 )
26 )
27where
27where
28
28
29-- base
29-- base
30−import Data.Kind ( Type )
30+import Data.Kind ( Constraint, Type )
31import Data.List.NonEmpty ( NonEmpty )
31import Data.List.NonEmpty ( NonEmpty )
32+import GHC.Generics (Generic)
32import Prelude
33import Prelude
33
34
34-- rel8
35-- rel8
35−import Rel8.Schema.Context.Label ( HLabelable, hlabeler, hunlabeler )
36+import Rel8.FCF ( Eval, Exp )
36import Rel8.Schema.Dict ( Dict( Dict ) )
37import Rel8.Schema.Dict ( Dict( Dict ) )
37import qualified Rel8.Schema.Kind as K
38import qualified Rel8.Schema.Kind as K
38−import Rel8.Schema.HTable
39+import Rel8.Schema.HTable ( HTable, hfield, htabulate, htabulateA, hspecs )
39− ( HTable
40+import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
40− , hfield, htabulate, htabulateA, hspecs
41+import Rel8.Schema.HTable.MapTable
42+ ( HMapTable( HMapTable ), HMapTableField( HMapTableField )
43+ , MapSpec, mapInfo
44+ , Precompose( Precompose )
41 )
45 )
46+import qualified Rel8.Schema.HTable.MapTable as HMapTable ( hproject )
42import Rel8.Schema.Null ( Unnullify, NotNull, Nullity( NotNull ) )
47import Rel8.Schema.Null ( Unnullify, NotNull, Nullity( NotNull ) )
43−import Rel8.Schema.Spec ( Spec( Spec ), SSpec(..) )
48+import Rel8.Schema.Spec ( Spec(..) )
44import Rel8.Type.Array ( listTypeInformation, nonEmptyTypeInformation )
49import Rel8.Type.Array ( listTypeInformation, nonEmptyTypeInformation )
45import Rel8.Type.Information ( TypeInformation )
50import Rel8.Type.Information ( TypeInformation )
46
51
47-- semialign
52-- semialign
48−import Data.Zip ( Unzip, Repeat, Zippy(..) )
53+import Data.Zip ( Unzip, Zip, Zippy(..) )
49−import Rel8.FCF
50−import Rel8.Schema.HTable.MapTable
51−import GHC.Generics (Generic)
52
54
53
55
56+type Vector :: (Type -> Type) -> Constraint
54class Vector list where
57class Vector list where
55 listNotNull :: proxy a -> Dict NotNull (list a)
58 listNotNull :: proxy a -> Dict NotNull (list a)
56 vectorTypeInformation :: ()
59 vectorTypeInformation :: ()
@@ -75,16 +78,16 @@ newtype HVectorize list table context = HVectorize (HMapTable (Vectorize list) t
75 deriving anyclass HTable
78 deriving anyclass HTable
76
79
77
80
78−data Vectorize :: (Type -> Type) -> Spec -> Exp Spec
81+data Vectorize :: (Type -> Type) -> Type -> Exp Type
79
82
80
83
81−type instance Eval (Vectorize list ('Spec labels necessity a)) = 'Spec labels necessity (list a)
84+type instance Eval (Vectorize list a) = list a
82
85
83
86
84instance Vector list => MapSpec (Vectorize list) where
87instance Vector list => MapSpec (Vectorize list) where
85 mapInfo = \case
88 mapInfo = \case
86− SSpec {..} -> case listNotNull @list nullity of
89+ Spec {..} -> case listNotNull @list nullity of
87− Dict -> SSpec
90+ Dict -> Spec
88 { nullity = NotNull
91 { nullity = NotNull
89 , info = vectorTypeInformation nullity info
92 , info = vectorTypeInformation nullity info
90 , ..
93 , ..
@@ -92,60 +95,49 @@ instance Vector list => MapSpec (Vectorize list) where
92
95
93
96
94hvectorize :: (HTable t, Unzip f, Vector list)
97hvectorize :: (HTable t, Unzip f, Vector list)
95− => (forall labels necessity a. ()
98+ => (forall a. Spec a -> f (context a) -> context' (list a))
96− => SSpec ('Spec labels necessity a)
97− -> f (context ('Spec labels necessity a))
98− -> context' ('Spec labels necessity (list a)))
99 -> f (t context)
99 -> f (t context)
100 -> HVectorize list t context'
100 -> HVectorize list t context'
101hvectorize vectorizer as = HVectorize $ htabulate $ \(HMapTableField field) ->
101hvectorize vectorizer as = HVectorize $ htabulate $ \(HMapTableField field) ->
102 case hfield hspecs field of
102 case hfield hspecs field of
103− spec@SSpec {} -> vectorizer spec (fmap (`hfield` field) as)
103+ spec -> vectorizer spec (fmap (`hfield` field) as)
104{-# INLINABLE hvectorize #-}
104{-# INLINABLE hvectorize #-}
105
105
106
106
107−hunvectorize :: (HTable t, Repeat f, Vector list)
107+hunvectorize :: (HTable t, Zip f, Vector list)
108− => (forall labels necessity a. ()
108+ => (forall a. Spec a -> context (list a) -> f (context' a))
109− => SSpec ('Spec labels necessity a)
110− -> context ('Spec labels necessity (list a))
111− -> f (context' ('Spec labels necessity a)))
112 -> HVectorize list t context
109 -> HVectorize list t context
113 -> f (t context')
110 -> f (t context')
114hunvectorize unvectorizer (HVectorize table) =
111hunvectorize unvectorizer (HVectorize table) =
115 getZippy $ htabulateA $ \field -> case hfield hspecs field of
112 getZippy $ htabulateA $ \field -> case hfield hspecs field of
116− spec@SSpec{} -> case hfield table (HMapTableField field) of
113+ spec -> case hfield table (HMapTableField field) of
117 a -> Zippy (unvectorizer spec a)
114 a -> Zippy (unvectorizer spec a)
118{-# INLINABLE hunvectorize #-}
115{-# INLINABLE hunvectorize #-}
119
116
120
117
121−happend :: (HTable t, Vector list) =>
118+happend :: (HTable t, Vector list)
122− ( forall labels necessity a. ()
119+ => (forall a. Spec a -> context (list a) -> context (list a) -> context (list a))
123− => Nullity a
124− -> TypeInformation (Unnullify a)
125− -> context ('Spec labels necessity (list a))
126− -> context ('Spec labels necessity (list a))
127− -> context ('Spec labels necessity (list a))
128− )
129 -> HVectorize list t context
120 -> HVectorize list t context
130 -> HVectorize list t context
121 -> HVectorize list t context
131 -> HVectorize list t context
122 -> HVectorize list t context
132happend append (HVectorize as) (HVectorize bs) = HVectorize $
123happend append (HVectorize as) (HVectorize bs) = HVectorize $
133 htabulate $ \field@(HMapTableField j) -> case (hfield as field, hfield bs field) of
124 htabulate $ \field@(HMapTableField j) -> case (hfield as field, hfield bs field) of
134 (a, b) -> case hfield hspecs j of
125 (a, b) -> case hfield hspecs j of
135− SSpec {nullity, info} -> append nullity info a b
126+ spec -> append spec a b
136
127
137
128
138−hempty :: HTable t =>
129+hempty :: HTable t
139− ( forall labels necessity a. ()
130+ => (forall a. Spec a -> context [a])
140− => Nullity a
141− -> TypeInformation (Unnullify a)
142− -> context ('Spec labels necessity [a])
143− )
144 -> HVectorize [] t context
131 -> HVectorize [] t context
145−hempty empty = HVectorize $ htabulate $ \(HMapTableField field) -> case hfield hspecs field of
132+hempty empty = HVectorize $ htabulate $ \(HMapTableField field) ->
146− SSpec {nullity, info} -> empty nullity info
133+ empty (hfield hspecs field)
134+
135+
136+hproject :: ()
137+ => (forall ctx. t ctx -> t' ctx)
138+ -> HVectorize list t context -> HVectorize list t' context
139+hproject f (HVectorize a) = HVectorize (HMapTable.hproject f a)
147
140
148
141
149−instance HLabelable g => HLabelable (Precompose (Vectorize list) g) where
142+hcolumn :: HVectorize list (HIdentity a) context -> context (list a)
150− hlabeler = Precompose . hlabeler . precomposed
143+hcolumn (HVectorize (HMapTable (HIdentity (Precompose a)))) = a
151− hunlabeler = Precompose . hunlabeler . precomposed
src/Rel8/Schema/Insert.hsdeleted−167
@@ -1,167 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language DuplicateRecordFields #-}
3−{-# language FlexibleContexts #-}
4−{-# language FlexibleInstances #-}
5−{-# language GADTs #-}
6−{-# language LambdaCase #-}
7−{-# language MultiParamTypeClasses #-}
8−{-# language NamedFieldPuns #-}
9−{-# language PolyKinds #-}
10−{-# language StandaloneKindSignatures #-}
11−{-# language TypeFamilies #-}
12−{-# language UndecidableInstances #-}
13−{-# language UndecidableSuperClasses #-}
14−
15−module Rel8.Schema.Insert
16− ( Insert(..)
17− , OnConflict(..)
18− , Col( RequiredInsert, OptionalInsert )
19− , Inserts
20− , Insertion(..)
21− )
22−where
23−
24−-- base
25−import Data.Functor.Identity ( Identity )
26−import Data.Kind ( Constraint, Type )
27−import Prelude
28−
29−-- rel8
30−import Rel8.Aggregate ( Aggregate )
31−import Rel8.Expr ( Expr )
32−import Rel8.Kind.Necessity ( Necessity(Optional, Required) )
33−import Rel8.Schema.Context ( Interpretation(..) )
34−import Rel8.Schema.Context.Label ( Labelable(..) )
35−import Rel8.Schema.Context.Nullify
36− ( Nullifiable, encodeTag, decodeTag, nullifier, unnullifier
37− , runTag, unnull
38− )
39−import Rel8.Schema.HTable.Type ( HType( HType ) )
40−import Rel8.Schema.Name ( Name, Selects )
41−import Rel8.Schema.Null ( Sql )
42−import Rel8.Schema.Reify ( notReify )
43−import Rel8.Schema.Result ( Result )
44−import Rel8.Schema.Spec ( SSpec(SSpec, nullity), Spec(Spec) )
45−import Rel8.Schema.Table ( TableSchema )
46−import Rel8.Statement.Returning ( Returning )
47−import Rel8.Table
48− ( Table, Context, Columns, fromColumns, toColumns
49− , reify, unreify
50− )
51−import Rel8.Table.Recontextualize ( Recontextualize )
52−import Rel8.Table.Tag ( Tag(..), fromExpr )
53−import Rel8.Type ( DBType )
54−
55−
56−-- | @OnConflict@ allows you to add an @ON CONFLICT@ clause to an @INSERT@
57−-- statement.
58−data OnConflict
59− = Abort -- ^ @ON CONFLICT ABORT@
60− | DoNothing -- ^ @ON CONFLICT DO NOTHING@
61−
62−
63−-- | The constituent parts of a SQL @INSERT@ statement.
64−type Insert :: k -> Type
65−data Insert a where
66− Insert :: (Selects names exprs, Inserts exprs inserts) =>
67− { into :: TableSchema names
68− -- ^ Which table to insert into.
69− , rows :: [inserts]
70− -- ^ The rows to insert.
71− , onConflict :: OnConflict
72− -- ^ What to do if the inserted rows conflict with data already in the
73− -- table.
74− , returning :: Returning names a
75− -- ^ What information to return on completion.
76− }
77− -> Insert a
78−
79−
80−instance Interpretation Insert where
81− data Col Insert _spec where
82− RequiredInsert :: Expr a -> Col Insert ('Spec labels 'Required a)
83− OptionalInsert :: Maybe (Expr a) -> Col Insert ('Spec labels 'Optional a)
84−
85−
86−type Insertion :: Type -> Type
87−newtype Insertion a = Insertion (Expr a)
88−
89−
90−instance Sql DBType a => Table Insert (Insertion a) where
91− type Columns (Insertion a) = HType a
92− type Context (Insertion a) = Insert
93−
94− toColumns (Insertion a) = HType (RequiredInsert a)
95− fromColumns (HType (RequiredInsert a)) = Insertion a
96− reify = notReify
97− unreify = notReify
98−
99−
100−instance Sql DBType a =>
101− Recontextualize Aggregate Insert (Aggregate (Expr a)) (Insertion a)
102−
103−
104−instance Sql DBType a => Recontextualize Expr Insert (Expr a) (Insertion a)
105−
106−
107−instance Sql DBType a =>
108− Recontextualize Result Insert (Identity a) (Insertion a)
109−
110−
111−instance Sql DBType a =>
112− Recontextualize Insert Aggregate (Insertion a) (Aggregate (Expr a))
113−
114−
115−instance Sql DBType a => Recontextualize Insert Expr (Insertion a) (Expr a)
116−
117−
118−instance Sql DBType a =>
119− Recontextualize Insert Result (Insertion a) (Identity a)
120−
121−
122−instance Sql DBType a => Recontextualize Insert Insert (Insertion a) (Insertion a)
123−
124−
125−instance Sql DBType a => Recontextualize Insert Name (Insertion a) (Name a)
126−
127−
128−instance Sql DBType a => Recontextualize Name Insert (Name a) (Insertion a)
129−
130−
131−instance Labelable Insert where
132− labeler = \case
133− RequiredInsert a -> RequiredInsert a
134− OptionalInsert ma -> OptionalInsert ma
135−
136− unlabeler = \case
137− RequiredInsert a -> RequiredInsert a
138− OptionalInsert ma -> OptionalInsert ma
139−
140−
141−instance Nullifiable Insert where
142− encodeTag = RequiredInsert . expr
143− decodeTag (RequiredInsert a) = fromExpr a
144−
145− nullifier Tag {expr} test SSpec {nullity} = \case
146− RequiredInsert a ->
147− RequiredInsert $ runTag nullity condition a
148− OptionalInsert ma ->
149− OptionalInsert $ runTag nullity condition <$> ma
150− where
151− condition = test expr
152−
153− unnullifier SSpec {nullity} = \case
154− RequiredInsert a -> RequiredInsert $ unnull nullity a
155− OptionalInsert ma -> OptionalInsert $ unnull nullity <$> ma
156−
157− {-# INLINABLE encodeTag #-}
158− {-# INLINABLE decodeTag #-}
159− {-# INLINABLE nullifier #-}
160− {-# INLINABLE unnullifier #-}
161−
162−
163−-- | @Inserts a b@ means that the columns in @a@ are compatible for inserting
164−-- with the table @b@.
165−type Inserts :: Type -> Type -> Constraint
166−class Recontextualize Expr Insert exprs inserts => Inserts exprs inserts
167−instance Recontextualize Expr Insert exprs inserts => Inserts exprs inserts
src/Rel8/Schema/Kind.hs+8−17
@@ -1,8 +1,9 @@
1{-# language StandaloneKindSignatures #-}
1{-# language StandaloneKindSignatures #-}
2
2
3module Rel8.Schema.Kind
3module Rel8.Schema.Kind
4− ( Context, Table
4+ ( Rel8able
5− , HContext, HTable
5+ , Context
6+ , HTable
6 )
7 )
7where
8where
8
9
@@ -10,24 +11,14 @@ where
10import Data.Kind ( Type )
11import Data.Kind ( Type )
11import Prelude ()
12import Prelude ()
12
13
13−-- rel8
14−import Rel8.Schema.Spec ( Spec )
15
14
16−
15+type Context :: Type
17−type HContext :: Type
16+type Context = Type -> Type
18−type HContext = Spec -> Type
19
17
20
18
21type HTable :: Type
19type HTable :: Type
22−type HTable = HContext -> Type
20+type HTable = Context -> Type
23−
24−
25−data X
26−
27−
28−type Context :: Type
29−type Context = X -> Type
30
21
31
22
32−type Table :: Type
23+type Rel8able :: Type
33−type Table = Context -> Type
24+type Rel8able = Context -> Type
src/Rel8/Schema/Name.hs+34−54
@@ -3,40 +3,44 @@
3{-# language FlexibleContexts #-}
3{-# language FlexibleContexts #-}
4{-# language FlexibleInstances #-}
4{-# language FlexibleInstances #-}
5{-# language GADTs #-}
5{-# language GADTs #-}
6+{-# language GeneralizedNewtypeDeriving #-}
6{-# language MultiParamTypeClasses #-}
7{-# language MultiParamTypeClasses #-}
7−{-# language PolyKinds #-}
8{-# language RankNTypes #-}
8{-# language RankNTypes #-}
9−{-# language StandaloneDeriving #-}
10{-# language StandaloneKindSignatures #-}
9{-# language StandaloneKindSignatures #-}
11{-# language TypeFamilies #-}
10{-# language TypeFamilies #-}
12{-# language UndecidableInstances #-}
11{-# language UndecidableInstances #-}
13−{-# language UndecidableSuperClasses #-}
14
12
15module Rel8.Schema.Name
13module Rel8.Schema.Name
16 ( Name(..)
14 ( Name(..)
17− , Col( NameCol )
18 , Selects
15 , Selects
16+ , ppColumn
19 )
17 )
20where
18where
21
19
22-- base
20-- base
23−import Data.Functor.Identity ( Identity )
21+import Data.Functor.Identity ( Identity( Identity ) )
24import Data.Kind ( Constraint, Type )
22import Data.Kind ( Constraint, Type )
25−import Data.String ( IsString, fromString )
23+import Data.String ( IsString )
26import Prelude
24import Prelude
27
25
26+-- opaleye
27+import qualified Opaleye.Internal.HaskellDB.Sql as Opaleye
28+import qualified Opaleye.Internal.HaskellDB.Sql.Print as Opaleye
29+
30+-- pretty
31+import Text.PrettyPrint ( Doc )
32+
28-- rel8
33-- rel8
29import Rel8.Expr ( Expr )
34import Rel8.Expr ( Expr )
30−import Rel8.Schema.Context ( Interpretation, Col )
35+import qualified Rel8.Schema.Kind as K
31−import Rel8.Schema.Context.Label ( Labelable, labeler, unlabeler )
36+import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
32−import Rel8.Schema.HTable.Type ( HType( HType ) )
33import Rel8.Schema.Null ( Sql )
37import Rel8.Schema.Null ( Sql )
34−import Rel8.Schema.Reify ( notReify )
35−import Rel8.Schema.Result ( Result )
36import Rel8.Table
38import Rel8.Table
37− ( Table, Columns, Context, fromColumns, toColumns, reify, unreify
39+ ( Table, Columns, Context, fromColumns, toColumns
40+ , FromExprs, fromResult, toResult
41+ , Transpose
38 )
42 )
39−import Rel8.Table.Recontextualize ( Recontextualize )
43+import Rel8.Table.Transpose ( Transposes )
40import Rel8.Type ( DBType )
44import Rel8.Type ( DBType )
41
45
42
46
@@ -44,54 +48,30 @@ import Rel8.Type ( DBType )
44-- schema definition. You can construct names by using the @OverloadedStrings@
48-- schema definition. You can construct names by using the @OverloadedStrings@
45-- extension and writing string literals. This is typically done when providing
49-- extension and writing string literals. This is typically done when providing
46-- a 'TableSchema' value.
50-- a 'TableSchema' value.
47−type Name :: k -> Type
51+type Name :: K.Context
48−data Name a where
52+newtype Name a = Name String
49− Name :: k ~ Type => !String -> Name (a :: k)
53+ deriving stock Show
50−
54+ deriving newtype IsString
51−
52−deriving stock instance Show (Name a)
53−
54−
55−instance k ~ Type => IsString (Name (a :: k)) where
56− fromString = Name
57
55
58
56
59instance Sql DBType a => Table Name (Name a) where
57instance Sql DBType a => Table Name (Name a) where
60− type Columns (Name a) = HType a
58+ type Columns (Name a) = HIdentity a
61 type Context (Name a) = Name
59 type Context (Name a) = Name
60+ type FromExprs (Name a) = a
61+ type Transpose to (Name a) = to a
62
62
63− toColumns (Name a) = HType (NameCol a)
63+ toColumns a = HIdentity a
64− fromColumns (HType (NameCol a)) = Name a
64+ fromColumns (HIdentity a) = a
65− reify = notReify
65+ toResult a = HIdentity (Identity a)
66− unreify = notReify
66+ fromResult (HIdentity (Identity a)) = a
67−
68−
69−instance Sql DBType a => Recontextualize Expr Name (Expr a) (Name a)
70−
71−
72−instance Sql DBType a => Recontextualize Result Name (Identity a) (Name a)
73−
74−
75−instance Sql DBType a => Recontextualize Name Expr (Name a) (Expr a)
76−
77−
78−instance Sql DBType a => Recontextualize Name Result (Name a) (Identity a)
79−
80−
81−instance Sql DBType a => Recontextualize Name Name (Name a) (Name a)
82−
83−
84−instance Interpretation Name where
85− newtype Col Name _spec = NameCol String
86−
87−
88−instance Labelable Name where
89− labeler (NameCol a) = NameCol a
90− unlabeler (NameCol a) = NameCol a
91
67
92
68
93-- | @Selects a b@ means that @a@ is a schema (i.e., a 'Table' of 'Name's) for
69-- | @Selects a b@ means that @a@ is a schema (i.e., a 'Table' of 'Name's) for
94-- the 'Expr' columns in @b@.
70-- the 'Expr' columns in @b@.
95type Selects :: Type -> Type -> Constraint
71type Selects :: Type -> Type -> Constraint
96−class Recontextualize Name Expr names exprs => Selects names exprs
72+class Transposes Name Expr names exprs => Selects names exprs
97−instance Recontextualize Name Expr names exprs => Selects names exprs
73+instance Transposes Name Expr names exprs => Selects names exprs
74+
75+
76+ppColumn :: String -> Doc
77+ppColumn = Opaleye.ppSqlExpr . Opaleye.ColumnSqlExpr . Opaleye.SqlColumn
src/Rel8/Schema/Reify.hsdeleted−74
@@ -1,74 +0,0 @@
1−{-# language AllowAmbiguousTypes #-}
2−{-# language EmptyCase #-}
3−{-# language DataKinds #-}
4−{-# language FlexibleInstances #-}
5−{-# language ScopedTypeVariables #-}
6−{-# language StandaloneKindSignatures #-}
7−{-# language TypeApplications #-}
8−{-# language TypeFamilies #-}
9−{-# language TypeOperators #-}
10−{-# language UndecidableInstances #-}
11−
12−module Rel8.Schema.Reify
13− ( Reify, Col( Reify ), hreify, hunreify
14− , UnwrapReify
15− , NotReify, notReify
16− )
17−where
18−
19−-- base
20−import Data.Kind ( Constraint )
21−import Data.Type.Equality ( (:~:)( Refl ) )
22−import Prelude
23−
24−-- rel8
25−import Rel8.Schema.Context ( Interpretation, Col )
26−import Rel8.Schema.Context.Label ( Labelable, labeler, unlabeler )
27−import Rel8.Schema.HTable ( HTable, hmap )
28−import Rel8.Schema.Kind ( Context )
29−
30−
31−type Reify :: Context -> Context
32−data Reify context a
33−
34−
35−instance Interpretation (Reify context) where
36− newtype Col (Reify context) spec = Reify (Col context spec)
37−
38−
39−instance Labelable context => Labelable (Reify context) where
40− labeler (Reify a) = Reify (labeler a)
41− unlabeler (Reify a) = Reify (unlabeler a)
42−
43−
44−hreify :: HTable t => t (Col context) -> t (Col (Reify context))
45−hreify = hmap Reify
46−
47−
48−hunreify :: HTable t => t (Col (Reify context)) -> t (Col context)
49−hunreify = hmap (\(Reify a) -> a)
50−
51−
52−type UnwrapReify :: Context -> Context
53−type family UnwrapReify context where
54− UnwrapReify (Reify context) = context
55−
56−
57−type IsReify :: Context -> Bool
58−type family IsReify context where
59− IsReify (Reify _) = 'True
60− IsReify _ = 'False
61−
62−
63−type NotReify :: Context -> Constraint
64−class IsReify context ~ 'False => NotReify context
65−instance IsReify context ~ 'False => NotReify context
66−
67−
68−notReify :: forall context ctx a. NotReify context => context :~: Reify ctx -> a
69−notReify refl = case lemma @context of
70− Refl -> case refl of
71−
72−
73−lemma :: NotReify context => IsReify context :~: 'False
74−lemma = Refl
src/Rel8/Schema/Result.hs+41−3
@@ -1,16 +1,54 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2+{-# language GADTs #-}
3+{-# language NamedFieldPuns #-}
2{-# language StandaloneKindSignatures #-}
4{-# language StandaloneKindSignatures #-}
5+{-# language TypeFamilies #-}
3
6
4module Rel8.Schema.Result
7module Rel8.Schema.Result
5 ( Result
8 ( Result
6− ) where
9+ , null, nullifier, unnullifier
10+ , vectorizer, unvectorizer
11+ )
12+where
7
13
8-- base
14-- base
9−import Prelude ()
15+import Data.Functor.Identity ( Identity( Identity), runIdentity )
16+import Prelude hiding ( null )
10
17
11-- rel8
18-- rel8
12import Rel8.Schema.Kind ( Context )
19import Rel8.Schema.Kind ( Context )
20+import Rel8.Schema.Null ( Nullify, Nullity( Null, NotNull ) )
21+import Rel8.Schema.Spec ( Spec(..) )
13
22
14
23
24+-- | The @Result@ context is the context used for decoded query results.
25+--
26+-- When a query is executed against a PostgreSQL database, Rel8 parses the
27+-- returned rows, decoding each row into the @Result@ context.
15type Result :: Context
28type Result :: Context
16−data Result a
29+type Result = Identity
30+
31+
32+null :: Result (Maybe a)
33+null = Identity Nothing
34+
35+
36+nullifier :: Spec a -> Result a -> Result (Nullify a)
37+nullifier Spec {nullity} (Identity a) = Identity $ case nullity of
38+ Null -> a
39+ NotNull -> Just a
40+
41+
42+unnullifier :: Spec a -> Result (Nullify a) -> Maybe (Result a)
43+unnullifier Spec {nullity} (Identity a) =
44+ case nullity of
45+ Null -> pure $ Identity a
46+ NotNull -> Identity <$> a
47+
48+
49+vectorizer :: Functor f => Spec a -> f (Result a) -> Result (f a)
50+vectorizer _ = Identity . fmap runIdentity
51+
52+
53+unvectorizer :: Functor f => Spec a -> Result (f a) -> f (Result a)
54+unvectorizer _ (Identity results) = Identity <$> results
src/Rel8/Schema/Spec.hs+17−45
@@ -1,62 +1,34 @@
1−{-# language DataKinds #-}
2{-# language FlexibleContexts #-}
1{-# language FlexibleContexts #-}
3−{-# language GADTs #-}
2+{-# language MonoLocalBinds #-}
4{-# language StandaloneKindSignatures #-}
3{-# language StandaloneKindSignatures #-}
5−{-# language UndecidableInstances #-}
6
4
7module Rel8.Schema.Spec
5module Rel8.Schema.Spec
8− ( Spec( Spec )
6+ ( Spec( Spec, labels, info, nullity )
9− , SSpec( SSpec, labels, necessity, info, nullity )
7+ , specification
10− , KnownSpec( specSing )
11 )
8 )
12where
9where
13
10
14-- base
11-- base
15−import Data.Kind ( Constraint, Type )
12+import Data.Kind ( Type )
16−import Prelude ()
13+import Prelude
17
14
18-- rel8
15-- rel8
19−import Rel8.Kind.Labels ( Labels, SLabels, KnownLabels, labelsSing )
20−import Rel8.Kind.Necessity
21− ( Necessity
22− , SNecessity
23− , KnownNecessity, necessitySing
24− )
25import Rel8.Schema.Null ( Nullity, Sql, Unnullify, nullable )
16import Rel8.Schema.Null ( Nullity, Sql, Unnullify, nullable )
26import Rel8.Type ( DBType, typeInformation )
17import Rel8.Type ( DBType, typeInformation )
27import Rel8.Type.Information ( TypeInformation )
18import Rel8.Type.Information ( TypeInformation )
28
19
29
20
30−type Spec :: Type
21+type Spec :: Type -> Type
31−data Spec = Spec Labels Necessity Type
22+data Spec a = Spec
32−
23+ { labels :: [String]
33−
24+ , info :: TypeInformation (Unnullify a)
34−type SSpec :: Spec -> Type
25+ , nullity :: Nullity a
35−data SSpec spec where
26+ }
36− SSpec ::
37− { labels :: SLabels labels
38− , necessity :: SNecessity necessity
39− , info :: TypeInformation (Unnullify a)
40− , nullity :: Nullity a
41− }
42− -> SSpec ('Spec labels necessity a)
43
27
44
28
45−type KnownSpec :: Spec -> Constraint
29+specification :: Sql DBType a => Spec a
46−class KnownSpec spec where
30+specification = Spec
47− specSing :: SSpec spec
31+ { labels = []
48−
32+ , info = typeInformation
49−
33+ , nullity = nullable
50−instance
34+ }
51− ( KnownLabels labels
52− , KnownNecessity necessity
53− , Sql DBType a
54− )
55− => KnownSpec ('Spec labels necessity a)
56− where
57− specSing = SSpec
58− { labels = labelsSing
59− , necessity = necessitySing
60− , info = typeInformation
61− , nullity = nullable
62− }
src/Rel8/Schema/Spec/ConstrainDBType.hsdeleted−64
@@ -1,64 +0,0 @@
1−{-# language ConstraintKinds #-}
2−{-# language DataKinds #-}
3−{-# language FlexibleInstances #-}
4−{-# language MultiParamTypeClasses #-}
5−{-# language QuantifiedConstraints #-}
6−{-# language StandaloneKindSignatures #-}
7−{-# language TypeFamilies #-}
8−{-# language UndecidableInstances #-}
9−
10−module Rel8.Schema.Spec.ConstrainDBType
11− ( ConstrainDBType
12− , dbTypeNullity
13− , dbTypeDict
14− , fromNullityDict
15− )
16−where
17−
18−-- base
19−import Data.Kind ( Constraint, Type )
20−import Prelude
21−
22−-- rel8
23−import Rel8.Schema.Dict ( Dict( Dict ) )
24−import Rel8.Schema.Null ( Unnullify, Nullity( Null, NotNull ), Sql, nullable )
25−import Rel8.Schema.Spec ( Spec( Spec ) )
26−
27−
28−type ConstrainDBType :: (Type -> Constraint) -> Spec -> Constraint
29−class
30− ( forall c labels necessity a. ()
31− => (spec ~ 'Spec labels necessity a)
32− => (forall x. (constraint x => c x)) => Sql c a
33− )
34− => ConstrainDBType constraint spec
35−instance
36− ( spec ~ 'Spec labels necessity a
37− , Sql constraint a
38− )
39− => ConstrainDBType constraint spec
40−
41−
42−dbTypeNullity :: Dict (ConstrainDBType c) ('Spec l n a) -> Nullity a
43−dbTypeNullity = step2 . step1
44− where
45− step1 :: Dict (ConstrainDBType c) ('Spec l n a) -> Dict (Sql c) a
46− step1 Dict = Dict
47−
48− step2 :: Dict (Sql c) a -> Nullity a
49− step2 Dict = nullable
50−
51−
52−dbTypeDict :: Dict (ConstrainDBType c) ('Spec l n a) -> Dict c (Unnullify a)
53−dbTypeDict = step2 . step1
54− where
55− step1 :: Dict (ConstrainDBType c) ('Spec l n a) -> Dict (Sql c) a
56− step1 Dict = Dict
57−
58− step2 :: Dict (Sql c) a -> Dict c (Unnullify a)
59− step2 Dict = Dict
60−
61−
62−fromNullityDict :: Nullity a -> Dict c (Unnullify a) -> Dict (ConstrainDBType c) ('Spec l n a)
63−fromNullityDict Null Dict = Dict
64−fromNullityDict NotNull Dict = Dict
src/Rel8/Schema/Spec/ConstrainType.hsdeleted−31
@@ -1,31 +0,0 @@
1−{-# language ConstraintKinds #-}
2−{-# language DataKinds #-}
3−{-# language FlexibleInstances #-}
4−{-# language MultiParamTypeClasses #-}
5−{-# language QuantifiedConstraints #-}
6−{-# language StandaloneKindSignatures #-}
7−{-# language TypeFamilies #-}
8−{-# language UndecidableInstances #-}
9−
10−module Rel8.Schema.Spec.ConstrainType
11− ( ConstrainType
12− )
13−where
14−
15−-- base
16−import Data.Kind ( Constraint, Type )
17−import Prelude ()
18−
19−-- rel8
20−import Rel8.Schema.Spec ( Spec( Spec ) )
21−
22−
23−type ConstrainType :: (Type -> Constraint) -> Spec -> Constraint
24−class
25− ( forall labels necessity a. ()
26− => (spec ~ 'Spec labels necessity a)
27− => constraint a
28− ) =>
29− ConstrainType constraint spec
30−instance (spec ~ 'Spec labels necessity a, constraint a) =>
31− ConstrainType constraint spec
src/Rel8/Schema/Structure.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language StandaloneKindSignatures #-}
3−
4−module Rel8.Schema.Structure
5− ( Structure
6− )
7−where
8−
9−-- base
10−import Prelude ()
11−
12−-- rel8
13−import Rel8.Schema.Kind ( Context )
14−
15−
16−type Structure :: Context
17−data Structure a
src/Rel8/Schema/Table.hs+20
@@ -1,14 +1,26 @@
1{-# language DeriveFunctor #-}
1{-# language DeriveFunctor #-}
2{-# language DerivingStrategies #-}
2{-# language DerivingStrategies #-}
3+{-# language DisambiguateRecordFields #-}
4+{-# language NamedFieldPuns #-}
5+{-# language StandaloneKindSignatures #-}
3
6
4module Rel8.Schema.Table
7module Rel8.Schema.Table
5 ( TableSchema(..)
8 ( TableSchema(..)
9+ , ppTable
6 )
10 )
7where
11where
8
12
9-- base
13-- base
14+import Data.Kind ( Type )
10import Prelude
15import Prelude
11
16
17+-- opaleye
18+import qualified Opaleye.Internal.HaskellDB.Sql as Opaleye
19+import qualified Opaleye.Internal.HaskellDB.Sql.Print as Opaleye
20+
21+-- pretty
22+import Text.PrettyPrint ( Doc )
23+
12
24
13-- | The schema for a table. This is used to specify the name and schema that a
25-- | The schema for a table. This is used to specify the name and schema that a
14-- table belongs to (the @FROM@ part of a SQL query), along with the schema of
26-- table belongs to (the @FROM@ part of a SQL query), along with the schema of
@@ -16,6 +28,7 @@ import Prelude
16--
28--
17-- For each selectable table in your database, you should provide a
29-- For each selectable table in your database, you should provide a
18-- @TableSchema@ in order to interact with the table via Rel8.
30-- @TableSchema@ in order to interact with the table via Rel8.
31+type TableSchema :: Type -> Type
19data TableSchema names = TableSchema
32data TableSchema names = TableSchema
20 { name :: String
33 { name :: String
21 -- ^ The name of the table.
34 -- ^ The name of the table.
@@ -27,3 +40,10 @@ data TableSchema names = TableSchema
27 -- data type here, parameterized by the 'Rel8.ColumnSchema.ColumnSchema' functor.
40 -- data type here, parameterized by the 'Rel8.ColumnSchema.ColumnSchema' functor.
28 }
41 }
29 deriving stock Functor
42 deriving stock Functor
43+
44+
45+ppTable :: TableSchema a -> Doc
46+ppTable TableSchema {name, schema} = Opaleye.ppTable Opaleye.SqlTable
47+ { sqlTableSchemaName = schema
48+ , sqlTableName = name
49+ }
src/Rel8/Statement/Delete.hs+35−48
@@ -1,40 +1,37 @@
1{-# language DuplicateRecordFields #-}
1{-# language DuplicateRecordFields #-}
2{-# language GADTs #-}
2{-# language GADTs #-}
3{-# language NamedFieldPuns #-}
3{-# language NamedFieldPuns #-}
4−{-# language ScopedTypeVariables #-}
4+{-# language RankNTypes #-}
5+{-# language RecordWildCards #-}
5{-# language StandaloneKindSignatures #-}
6{-# language StandaloneKindSignatures #-}
6−{-# language TypeApplications #-}
7+{-# language StrictData #-}
7
8
8module Rel8.Statement.Delete
9module Rel8.Statement.Delete
9 ( Delete(..)
10 ( Delete(..)
10 , delete
11 , delete
12+ , ppDelete
11 )
13 )
12where
14where
13
15
14-- base
16-- base
15−import Control.Exception ( throwIO )
16import Data.Kind ( Type )
17import Data.Kind ( Type )
17import Prelude
18import Prelude
18
19
19-- hasql
20-- hasql
20−import Hasql.Connection ( Connection )
21−import qualified Hasql.Decoders as Hasql
22import qualified Hasql.Encoders as Hasql
21import qualified Hasql.Encoders as Hasql
23−import qualified Hasql.Session as Hasql
24import qualified Hasql.Statement as Hasql
22import qualified Hasql.Statement as Hasql
25
23
26−-- opaleye
24+-- pretty
27−import qualified Opaleye.Internal.Manipulation as Opaleye
25+import Text.PrettyPrint ( Doc, (<+>), ($$), text )
28
26
29-- rel8
27-- rel8
30import Rel8.Expr ( Expr )
28import Rel8.Expr ( Expr )
31−import Rel8.Expr.Opaleye ( toColumn, toPrimExpr )
29+import Rel8.Query ( Query )
32import Rel8.Schema.Name ( Selects )
30import Rel8.Schema.Name ( Selects )
33−import Rel8.Schema.Table ( TableSchema )
31+import Rel8.Schema.Table ( TableSchema, ppTable )
34−import Rel8.Statement.Returning ( Returning( NumberOfRowsAffected, Projection ) )
32+import Rel8.Statement.Returning ( Returning, decodeReturning, ppReturning )
35−import Rel8.Table ( fromColumns, toColumns )
33+import Rel8.Statement.Using ( ppUsing )
36−import Rel8.Table.Opaleye ( castTable, table, unpackspec )
34+import Rel8.Statement.Where ( ppWhere )
37−import Rel8.Table.Serialize ( Serializable, parse )
38
35
39-- text
36-- text
40import qualified Data.Text as Text
37import qualified Data.Text as Text
@@ -47,7 +44,10 @@ data Delete a where
47 Delete :: Selects names exprs =>
44 Delete :: Selects names exprs =>
48 { from :: TableSchema names
45 { from :: TableSchema names
49 -- ^ Which table to delete from.
46 -- ^ Which table to delete from.
50− , deleteWhere :: exprs -> Expr Bool
47+ , using :: Query using
48+ -- ^ @USING@ clause — this can be used to join against other tables,
49+ -- and its results can be referenced in the @WHERE@ clause
50+ , deleteWhere :: using -> exprs -> Expr Bool
51 -- ^ Which rows should be selected for deletion.
51 -- ^ Which rows should be selected for deletion.
52 , returning :: Returning names a
52 , returning :: Returning names a
53 -- ^ What to return from the @DELETE@ statement.
53 -- ^ What to return from the @DELETE@ statement.
@@ -55,38 +55,25 @@ data Delete a where
55 -> Delete a
55 -> Delete a
56
56
57
57
58−-- | Run a @DELETE@ statement.
58+ppDelete :: Delete a -> Doc
59−delete :: Connection -> Delete a -> IO a
59+ppDelete Delete {..} = case ppUsing using of
60−delete c Delete {from, deleteWhere, returning} =
60+ Nothing ->
61− case returning of
61+ text "DELETE FROM" <+> ppTable from $$
62− NumberOfRowsAffected -> Hasql.run session c >>= either throwIO pure
62+ text "WHERE false"
63− where
63+ Just (usingDoc, i) ->
64− session = Hasql.statement () statement
64+ text "DELETE FROM" <+> ppTable from $$
65− statement = Hasql.Statement bytes params decode prepare
65+ usingDoc $$
66− bytes = encodeUtf8 $ Text.pack sql
66+ ppWhere from (deleteWhere i) $$
67− params = Hasql.noParams
67+ ppReturning from returning
68− decode = Hasql.rowsAffected
69− prepare = False
70− sql = Opaleye.arrangeDeleteSql from' where'
71− where
72− from' = table $ toColumns <$> from
73− where' = toColumn . toPrimExpr . deleteWhere . fromColumns
74
68
75− Projection project -> Hasql.run session c >>= either throwIO pure
69+
76− where
70+-- | Run a 'Delete' statement.
77− session = Hasql.statement () statement
71+delete :: Delete a -> Hasql.Statement () a
78− statement = Hasql.Statement bytes params decode prepare
72+delete d@Delete {returning} = Hasql.Statement bytes params decode prepare
79− bytes = encodeUtf8 $ Text.pack sql
80− params = Hasql.noParams
81− decode = decoder project
82− prepare = False
83− sql =
84− Opaleye.arrangeDeleteReturningSql unpackspec from' where' project'
85− where
86− from' = table $ toColumns <$> from
87− where' = toColumn . toPrimExpr . deleteWhere . fromColumns
88− project' = castTable . toColumns . project . fromColumns
89 where
73 where
90− decoder :: forall exprs projection a. Serializable projection a
74+ bytes = encodeUtf8 $ Text.pack sql
91− => (exprs -> projection) -> Hasql.Result [a]
75+ params = Hasql.noParams
92− decoder _ = Hasql.rowList (parse @projection @a)
76+ decode = decodeReturning returning
77+ prepare = False
78+ sql = show doc
79+ doc = ppDelete d
src/Rel8/Statement/Insert.hs+60−60
@@ -1,89 +1,89 @@
1+{-# language DuplicateRecordFields #-}
2+{-# language FlexibleContexts #-}
1{-# language GADTs #-}
3{-# language GADTs #-}
2{-# language NamedFieldPuns #-}
4{-# language NamedFieldPuns #-}
3−{-# language ScopedTypeVariables #-}
5+{-# language RecordWildCards #-}
4−{-# language TypeApplications #-}
6+{-# language StandaloneKindSignatures #-}
7+{-# language StrictData #-}
5
8
6module Rel8.Statement.Insert
9module Rel8.Statement.Insert
7 ( Insert(..)
10 ( Insert(..)
8− , OnConflict(..)
9 , insert
11 , insert
12+ , ppInsert
13+ , ppInto
10 )
14 )
11where
15where
12
16
13-- base
17-- base
14−import Control.Exception ( throwIO )
18+import Data.Foldable ( toList )
15−import Data.List.NonEmpty ( NonEmpty( (:|) ) )
19+import Data.Kind ( Type )
16import Prelude
20import Prelude
17
21
18-- hasql
22-- hasql
19−import Hasql.Connection ( Connection )
20−import qualified Hasql.Decoders as Hasql
21import qualified Hasql.Encoders as Hasql
23import qualified Hasql.Encoders as Hasql
22−import qualified Hasql.Session as Hasql
23import qualified Hasql.Statement as Hasql
24import qualified Hasql.Statement as Hasql
24
25
25-- opaleye
26-- opaleye
26−import qualified Opaleye.Internal.Manipulation as Opaleye
27+import qualified Opaleye.Internal.HaskellDB.Sql.Print as Opaleye
27−import qualified Opaleye.Manipulation as Opaleye
28+
29+-- pretty
30+import Text.PrettyPrint ( Doc, (<+>), ($$), parens, text )
28
31
29-- rel8
32-- rel8
30−import Rel8.Schema.Insert ( Insert(..), OnConflict(..) )
33+import Rel8.Query ( Query )
31−import Rel8.Statement.Returning ( Returning( Projection, NumberOfRowsAffected ) )
34+import Rel8.Schema.Name ( Name, Selects, ppColumn )
32−import Rel8.Table ( fromColumns, toColumns )
35+import Rel8.Schema.Table ( TableSchema(..), ppTable )
33−import Rel8.Table.Opaleye ( castTable, table, unpackspec )
36+import Rel8.Statement.OnConflict ( OnConflict, ppOnConflict )
34−import Rel8.Table.Serialize ( Serializable, parse )
37+import Rel8.Statement.Returning ( Returning, decodeReturning, ppReturning )
38+import Rel8.Statement.Select ( ppRows )
39+import Rel8.Table ( Table )
40+import Rel8.Table.Name ( showNames )
35
41
36-- text
42-- text
37import qualified Data.Text as Text ( pack )
43import qualified Data.Text as Text ( pack )
38import Data.Text.Encoding ( encodeUtf8 )
44import Data.Text.Encoding ( encodeUtf8 )
39
45
40
46
41−-- | Run an @INSERT@ statement
47+-- | The constituent parts of a SQL @INSERT@ statement.
42−insert :: Connection -> Insert a -> IO a
48+type Insert :: Type -> Type
43−insert c Insert {into, rows, onConflict, returning} =
49+data Insert a where
44− case (rows, returning) of
50+ Insert :: Selects names exprs =>
45− ([], NumberOfRowsAffected) -> pure 0
51+ { into :: TableSchema names
46− ([], Projection _) -> pure []
52+ -- ^ Which table to insert into.
53+ , rows :: Query exprs
54+ -- ^ The rows to insert. This can be an arbitrary query — use
55+ -- 'Rel8.values' insert a static list of rows.
56+ , onConflict :: OnConflict names
57+ -- ^ What to do if the inserted rows conflict with data already in the
58+ -- table.
59+ , returning :: Returning names a
60+ -- ^ What information to return on completion.
61+ }
62+ -> Insert a
47
63
48− (x:xs, NumberOfRowsAffected) -> Hasql.run session c >>= either throwIO pure
49− where
50− session = Hasql.statement () statement
51− statement = Hasql.Statement bytes params decode prepare
52− bytes = encodeUtf8 $ Text.pack sql
53− params = Hasql.noParams
54− decode = Hasql.rowsAffected
55− prepare = False
56− sql = Opaleye.arrangeInsertManySql into' rows' onConflict'
57− where
58− into' = table $ toColumns <$> into
59− rows' = toColumns <$> x :| xs
60
64
61− (x:xs, Projection project) -> Hasql.run session c >>= either throwIO pure
65+ppInsert :: Insert a -> Doc
62− where
66+ppInsert Insert {..} =
63− session = Hasql.statement () statement
67+ text "INSERT INTO" <+>
64− statement = Hasql.Statement bytes params decode prepare
68+ ppInto into $$
65− bytes = encodeUtf8 $ Text.pack sql
69+ ppRows rows $$
66− params = Hasql.noParams
70+ ppOnConflict into onConflict $$
67− decode = decoder project
71+ ppReturning into returning
68− prepare = False
69− sql =
70− Opaleye.arrangeInsertManyReturningSql
71− unpackspec
72− into'
73− rows'
74− project'
75− onConflict'
76− where
77− into' = table $ toColumns <$> into
78− rows' = toColumns <$> x :| xs
79− project' = castTable . toColumns . project . fromColumns
80
72
81− where
82− onConflict' =
83− case onConflict of
84− DoNothing -> Just Opaleye.DoNothing
85− Abort -> Nothing
86
73
87− decoder :: forall exprs projection a. Serializable projection a
74+ppInto :: Table Name a => TableSchema a -> Doc
88− => (exprs -> projection) -> Hasql.Result [a]
75+ppInto table@TableSchema {columns} =
89− decoder _ = Hasql.rowList (parse @projection @a)
76+ ppTable table <+>
77+ parens (Opaleye.commaV ppColumn (toList (showNames columns)))
78+
79+
80+-- | Run an 'Insert' statement.
81+insert :: Insert a -> Hasql.Statement () a
82+insert i@Insert {returning} = Hasql.Statement bytes params decode prepare
83+ where
84+ bytes = encodeUtf8 $ Text.pack sql
85+ params = Hasql.noParams
86+ decode = decodeReturning returning
87+ prepare = False
88+ sql = show doc
89+ doc = ppInsert i
src/Rel8/Statement/OnConflict.hsnew file+106
@@ -0,0 +1,106 @@
1+{-# language DuplicateRecordFields #-}
2+{-# language FlexibleContexts #-}
3+{-# language GADTs #-}
4+{-# language LambdaCase #-}
5+{-# language NamedFieldPuns #-}
6+{-# language RecordWildCards #-}
7+{-# language StandaloneKindSignatures #-}
8+{-# language StrictData #-}
9+
10+module Rel8.Statement.OnConflict
11+ ( OnConflict(..)
12+ , Upsert(..)
13+ , ppOnConflict
14+ )
15+where
16+
17+-- base
18+import Data.Foldable ( toList )
19+import Data.Kind ( Type )
20+import Prelude
21+
22+-- opaleye
23+import qualified Opaleye.Internal.HaskellDB.Sql.Print as Opaleye
24+
25+-- pretty
26+import Text.PrettyPrint ( Doc, (<+>), ($$), parens, text )
27+
28+-- rel8
29+import Rel8.Expr ( Expr )
30+import Rel8.Schema.Name ( Name, Selects, ppColumn )
31+import Rel8.Schema.Table ( TableSchema(..) )
32+import Rel8.Statement.Set ( ppSet )
33+import Rel8.Statement.Where ( ppWhere )
34+import Rel8.Table ( Table, toColumns )
35+import Rel8.Table.Cols ( Cols( Cols ) )
36+import Rel8.Table.Name ( showNames )
37+import Rel8.Table.Opaleye ( attributes )
38+import Rel8.Table.Projection ( Projecting, Projection, apply )
39+
40+
41+-- | 'OnConflict' represents the @ON CONFLICT@ clause of an @INSERT@
42+-- statement. This specifies what ought to happen when one or more of the
43+-- rows proposed for insertion conflict with an existing row in the table.
44+type OnConflict :: Type -> Type
45+data OnConflict names
46+ = Abort
47+ -- ^ Abort the transaction if there are conflicting rows (Postgres' default)
48+ | DoNothing
49+ -- ^ @ON CONFLICT DO NOTHING@
50+ | DoUpdate (Upsert names)
51+ -- ^ @ON CONFLICT DO UPDATE@
52+
53+
54+-- | The @ON CONFLICT (...) DO UPDATE@ clause of an @INSERT@ statement, also
55+-- known as \"upsert\".
56+--
57+-- When an existing row conflicts with a row proposed for insertion,
58+-- @ON CONFLICT DO UPDATE@ allows you to instead update this existing row. The
59+-- conflicting row proposed for insertion is then \"excluded\", but its values
60+-- can still be referenced from the @SET@ and @WHERE@ clauses of the @UPDATE@
61+-- statement.
62+--
63+-- Upsert in Postgres requires an explicit set of \"conflict targets\" — the
64+-- set of columns comprising the @UNIQUE@ index from conflicts with which we
65+-- would like to recover.
66+type Upsert :: Type -> Type
67+data Upsert names where
68+ Upsert :: (Selects names exprs, Projecting names index, excluded ~ exprs) =>
69+ { index :: Projection names index
70+ -- ^ The set of conflict targets, projected from the set of columns for
71+ -- the whole table
72+ , set :: excluded -> exprs -> exprs
73+ -- ^ How to update each selected row.
74+ , updateWhere :: excluded -> exprs -> Expr Bool
75+ -- ^ Which rows to select for update.
76+ }
77+ -> Upsert names
78+
79+
80+ppOnConflict :: TableSchema names -> OnConflict names -> Doc
81+ppOnConflict schema = \case
82+ Abort -> mempty
83+ DoNothing -> text "ON CONFLICT DO NOTHING"
84+ DoUpdate upsert -> ppUpsert schema upsert
85+
86+
87+ppUpsert :: TableSchema names -> Upsert names -> Doc
88+ppUpsert schema@TableSchema {columns} Upsert {..} =
89+ text "ON CONFLICT" <+>
90+ ppIndex schema index <+>
91+ text "DO UPDATE" $$
92+ ppSet schema (set excluded) $$
93+ ppWhere schema (updateWhere excluded)
94+ where
95+ excluded = attributes TableSchema
96+ { schema = Nothing
97+ , name = "excluded"
98+ , columns
99+ }
100+
101+
102+ppIndex :: (Table Name names, Projecting names index)
103+ => TableSchema names -> Projection names index -> Doc
104+ppIndex TableSchema {columns} index =
105+ parens $ Opaleye.commaV ppColumn $ toList $
106+ showNames $ Cols $ apply index $ toColumns columns
src/Rel8/Statement/Returning.hs+114−10
@@ -1,29 +1,133 @@
1{-# language GADTs #-}
1{-# language GADTs #-}
2+{-# language LambdaCase #-}
3+{-# language NamedFieldPuns #-}
4+{-# language RankNTypes #-}
5+{-# language ScopedTypeVariables #-}
2{-# language StandaloneKindSignatures #-}
6{-# language StandaloneKindSignatures #-}
7+{-# language StrictData #-}
8+{-# language TypeApplications #-}
3
9
4module Rel8.Statement.Returning
10module Rel8.Statement.Returning
5− ( Returning(..)
11+ ( Returning( NumberOfRowsAffected, Projection )
12+ , decodeReturning
13+ , ppReturning
6 )
14 )
7where
15where
8
16
9-- base
17-- base
18+import Control.Applicative ( liftA2 )
19+import Data.Foldable ( toList )
10import Data.Int ( Int64 )
20import Data.Int ( Int64 )
11import Data.Kind ( Type )
21import Data.Kind ( Type )
12−import Prelude ()
22+import Data.List.NonEmpty ( NonEmpty )
23+import Prelude
24+
25+-- hasql
26+import qualified Hasql.Decoders as Hasql
27+
28+-- opaleye
29+import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
30+import qualified Opaleye.Internal.HaskellDB.Sql.Print as Opaleye
31+import qualified Opaleye.Internal.Sql as Opaleye
32+
33+-- pretty
34+import Text.PrettyPrint ( Doc, (<+>), text )
13
35
14-- rel8
36-- rel8
15import Rel8.Schema.Name ( Selects )
37import Rel8.Schema.Name ( Selects )
16−import Rel8.Table.Serialize ( Serializable )
38+import Rel8.Schema.Table ( TableSchema(..) )
39+import Rel8.Table.Opaleye ( castTable, exprs, view )
40+import Rel8.Table.Serialize ( Serializable, parse )
17
41
42+-- semigropuoids
43+import Data.Functor.Apply ( Apply, (<.>) )
18
44
19−-- | @INSERT@, @UPDATE@ and @DELETE@ all support returning either the number of
45+
20−-- rows affected, or the actual rows modified. 'Projection' allows you to
46+-- | 'Rel8.Insert', 'Rel8.Update' and 'Rel8.Delete' all support returning either
21−-- project out of these returned rows, which can be useful if you want to log
47+-- the number of rows affected, or the actual rows modified.
22−-- exactly which rows were deleted, or to view a generated id (for example, if
23−-- using a column with an autoincrementing counter as a default value).
24type Returning :: Type -> Type -> Type
48type Returning :: Type -> Type -> Type
25data Returning names a where
49data Returning names a where
50+ Pure :: a -> Returning names a
51+ Ap :: Returning names (a -> b) -> Returning names a -> Returning names b
52+
53+ -- | Return the number of rows affected.
26 NumberOfRowsAffected :: Returning names Int64
54 NumberOfRowsAffected :: Returning names Int64
27− Projection :: (Selects names exprs, Serializable projection a)
55+
28− => (exprs -> projection)
56+ -- | 'Projection' allows you to project out of the affected rows, which can
57+ -- be useful if you want to log exactly which rows were deleted, or to view
58+ -- a generated id (for example, if using a column with an autoincrementing
59+ -- counter via 'Rel8.nextval').
60+ Projection :: (Selects names exprs, Serializable returning a)
61+ => (exprs -> returning)
29 -> Returning names [a]
62 -> Returning names [a]
63+
64+
65+instance Functor (Returning names) where
66+ fmap f = \case
67+ Pure a -> Pure (f a)
68+ Ap g a -> Ap (fmap (f .) g) a
69+ m -> Ap (Pure f) m
70+
71+
72+instance Apply (Returning names) where
73+ (<.>) = Ap
74+
75+
76+instance Applicative (Returning names) where
77+ pure = Pure
78+ (<*>) = Ap
79+
80+
81+projections :: ()
82+ => TableSchema names -> Returning names a -> Maybe (NonEmpty Opaleye.PrimExpr)
83+projections schema@TableSchema {columns} = \case
84+ Pure _ -> Nothing
85+ Ap f a -> projections schema f <> projections schema a
86+ NumberOfRowsAffected -> Nothing
87+ Projection f -> Just (exprs (castTable (f (view columns))))
88+
89+
90+runReturning :: ()
91+ => ((Int64 -> a) -> r)
92+ -> (forall x. Hasql.Row x -> ([x] -> a) -> r)
93+ -> Returning names a
94+ -> r
95+runReturning rowCount rowList = \case
96+ Pure a -> rowCount (const a)
97+ Ap fs as ->
98+ runReturning
99+ (\withCount ->
100+ runReturning
101+ (\withCount' -> rowCount (withCount <*> withCount'))
102+ (\decoder -> rowList decoder . liftA2 withCount length64)
103+ as)
104+ (\decoder withRows ->
105+ runReturning
106+ (\withCount -> rowList decoder $ withRows <*> withCount . length64)
107+ (\decoder' withRows' ->
108+ rowList (liftA2 (,) decoder decoder') $
109+ withRows <$> fmap fst <*> withRows' . fmap snd)
110+ as)
111+ fs
112+ NumberOfRowsAffected -> rowCount id
113+ Projection (_ :: exprs -> returning) -> rowList decoder' id
114+ where
115+ decoder' = parse @returning
116+ where
117+ length64 :: Foldable f => f x -> Int64
118+ length64 = fromIntegral . length
119+
120+
121+decodeReturning :: Returning names a -> Hasql.Result a
122+decodeReturning = runReturning
123+ (<$> Hasql.rowsAffected)
124+ (\decoder withRows -> withRows <$> Hasql.rowList decoder)
125+
126+
127+ppReturning :: TableSchema names -> Returning names a -> Doc
128+ppReturning schema returning = case projections schema returning of
129+ Nothing -> mempty
130+ Just columns ->
131+ text "RETURNING" <+> Opaleye.commaV Opaleye.ppSqlExpr (toList sqlExprs)
132+ where
133+ sqlExprs = Opaleye.sqlExpr <$> columns
src/Rel8/Statement/SQL.hsnew file+29
@@ -0,0 +1,29 @@
1+module Rel8.Statement.SQL
2+ ( showDelete
3+ , showInsert
4+ , showUpdate
5+ )
6+where
7+
8+-- base
9+import Prelude
10+
11+-- rel8
12+import Rel8.Statement.Delete ( Delete, ppDelete )
13+import Rel8.Statement.Insert ( Insert, ppInsert )
14+import Rel8.Statement.Update ( Update, ppUpdate )
15+
16+
17+-- | Convert a 'Delete' to a 'String' containing a @DELETE@ statement.
18+showDelete :: Delete a -> String
19+showDelete = show . ppDelete
20+
21+
22+-- | Convert an 'Insert' to a 'String' containing an @INSERT@ statement.
23+showInsert :: Insert a -> String
24+showInsert = show . ppInsert
25+
26+
27+-- | Convert an 'Update' to a 'String' containing an @UPDATE@ statement.
28+showUpdate :: Update a -> String
29+showUpdate = show . ppUpdate
src/Rel8/Statement/Select.hs+120−35
@@ -1,62 +1,147 @@
1+{-# language DeriveTraversable #-}
2+{-# language DerivingStrategies #-}
3+{-# language FlexibleContexts #-}
1{-# language MonoLocalBinds #-}
4{-# language MonoLocalBinds #-}
2{-# language ScopedTypeVariables #-}
5{-# language ScopedTypeVariables #-}
6+{-# language StandaloneKindSignatures #-}
3{-# language TypeApplications #-}
7{-# language TypeApplications #-}
4
8
5module Rel8.Statement.Select
9module Rel8.Statement.Select
6 ( select
10 ( select
7− , selectWithNames
11+ , ppSelect
12+
13+ , Optimized(..)
14+ , ppPrimSelect
15+ , ppRows
8 )
16 )
9where
17where
10
18
11-- base
19-- base
12−import Control.Exception ( throwIO )
20+import Data.Foldable ( toList )
13−import Prelude
21+import Data.Kind ( Type )
22+import Data.Void ( Void )
23+import Prelude hiding ( undefined )
14
24
15-- hasql
25-- hasql
16−import Hasql.Connection ( Connection )
17import qualified Hasql.Decoders as Hasql
26import qualified Hasql.Decoders as Hasql
18import qualified Hasql.Encoders as Hasql
27import qualified Hasql.Encoders as Hasql
19−import qualified Hasql.Session as Hasql
20import qualified Hasql.Statement as Hasql
28import qualified Hasql.Statement as Hasql
21
29
30+-- opaleye
31+import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
32+import qualified Opaleye.Internal.HaskellDB.Sql as Opaleye
33+import qualified Opaleye.Internal.HaskellDB.Sql.Print as Opaleye
34+import qualified Opaleye.Internal.PrimQuery as Opaleye
35+import qualified Opaleye.Internal.Print as Opaleye
36+import qualified Opaleye.Internal.Optimize as Opaleye
37+import qualified Opaleye.Internal.QueryArr as Opaleye hiding ( Select )
38+import qualified Opaleye.Internal.Sql as Opaleye hiding ( Values )
39+import qualified Opaleye.Internal.Tag as Opaleye
40+
41+-- pretty
42+import Text.PrettyPrint ( Doc )
43+
22-- rel8
44-- rel8
45+import Rel8.Expr ( Expr )
46+import Rel8.Expr.Bool ( false )
47+import Rel8.Expr.Opaleye ( toPrimExpr )
23import Rel8.Query ( Query )
48import Rel8.Query ( Query )
24−import Rel8.Query.SQL ( sqlForQuery, sqlForQueryWithNames )
49+import Rel8.Query.Opaleye ( toOpaleye )
25import Rel8.Schema.Name ( Selects )
50import Rel8.Schema.Name ( Selects )
51+import Rel8.Table ( Table )
52+import Rel8.Table.Cols ( toCols )
53+import Rel8.Table.Name ( namesFromLabels )
54+import Rel8.Table.Opaleye ( castTable, exprsWithNames )
55+import qualified Rel8.Table.Opaleye as T
26import Rel8.Table.Serialize ( Serializable, parse )
56import Rel8.Table.Serialize ( Serializable, parse )
57+import Rel8.Table.Undefined ( undefined )
27
58
28-- text
59-- text
29import qualified Data.Text as Text
60import qualified Data.Text as Text
30import Data.Text.Encoding ( encodeUtf8 )
61import Data.Text.Encoding ( encodeUtf8 )
31
62
32
63
33−-- | Run a @SELECT@ query, returning all rows.
64+-- | Run a @SELECT@ statement, returning all rows.
34select :: forall exprs a. Serializable exprs a
65select :: forall exprs a. Serializable exprs a
35− => Connection -> Query exprs -> IO [a]
66+ => Query exprs -> Hasql.Statement () [a]
36−select c query = case sqlForQuery query of
67+select query = Hasql.Statement bytes params decode prepare
37− Nothing -> pure []
68+ where
38− Just sql -> Hasql.run session c >>= either throwIO pure
69+ bytes = encodeUtf8 (Text.pack sql)
39− where
70+ params = Hasql.noParams
40− session = Hasql.statement () statement
71+ decode = Hasql.rowList (parse @exprs @a)
41− statement = Hasql.Statement bytes params decode prepare
72+ prepare = False
42− bytes = encodeUtf8 (Text.pack sql)
73+ sql = show doc
43− params = Hasql.noParams
74+ doc = ppSelect query
44− decode = Hasql.rowList (parse @exprs @a)
75+
45− prepare = False
76+
46−
77+ppSelect :: Table Expr a => Query a -> Doc
47−
78+ppSelect query =
48−selectWithNames :: forall exprs a names.
79+ Opaleye.ppSql $ primSelectWith names (toCols exprs') primQuery'
49− ( Selects names exprs
80+ where
50− , Serializable exprs a
81+ names = namesFromLabels
51− )
82+ (exprs, primQuery, _) =
52− => Connection -> names -> Query exprs -> IO [a]
83+ Opaleye.runSimpleQueryArrStart (toOpaleye query) ()
53−selectWithNames c names query = case sqlForQueryWithNames names query of
84+ (exprs', primQuery') = case optimize primQuery of
54− Nothing -> pure []
85+ Empty -> (undefined, Opaleye.Product (pure (pure Opaleye.Unit)) never)
55− Just sql -> Hasql.run session c >>= either throwIO pure
86+ Unit -> (exprs, Opaleye.Unit)
56− where
87+ Optimized pq -> (exprs, pq)
57− session = Hasql.statement () statement
88+ never = pure (toPrimExpr false)
58− statement = Hasql.Statement bytes params decode prepare
89+
59− bytes = encodeUtf8 (Text.pack sql)
90+
60− params = Hasql.noParams
91+ppRows :: Table Expr a => Query a -> Doc
61− decode = Hasql.rowList (parse @exprs @a)
92+ppRows query = case optimize primQuery of
62− prepare = False
93+ -- Special case VALUES because we can't use DEFAULT inside a SELECT
94+ Optimized (Opaleye.Values symbols rows)
95+ | eqSymbols symbols (toList (T.exprs a)) ->
96+ Opaleye.ppValues_ (map Opaleye.sqlExpr <$> toList rows)
97+ _ -> ppSelect query
98+ where
99+ (a, primQuery, _) = Opaleye.runSimpleQueryArrStart (toOpaleye query) ()
100+
101+ eqSymbols (symbol : symbols) (Opaleye.AttrExpr symbol' : exprs)
102+ | eqSymbol symbol symbol' = eqSymbols symbols exprs
103+ | otherwise = False
104+ eqSymbols [] [] = True
105+ eqSymbols _ _ = False
106+
107+ eqSymbol
108+ (Opaleye.Symbol name (Opaleye.UnsafeTag tag))
109+ (Opaleye.Symbol name' (Opaleye.UnsafeTag tag'))
110+ = name == name' && tag == tag'
111+
112+
113+ppPrimSelect :: Query a -> (Optimized Doc, a)
114+ppPrimSelect query =
115+ (Opaleye.ppSql . primSelect <$> optimize primQuery, a)
116+ where
117+ (a, primQuery, _) = Opaleye.runSimpleQueryArrStart (toOpaleye query) ()
118+
119+
120+type Optimized :: Type -> Type
121+data Optimized a = Empty | Unit | Optimized a
122+ deriving stock (Functor, Foldable, Traversable, Show)
123+
124+
125+optimize :: Opaleye.PrimQuery' a -> Optimized (Opaleye.PrimQuery' Void)
126+optimize query = case Opaleye.removeEmpty (Opaleye.optimize query) of
127+ Nothing -> Empty
128+ Just Opaleye.Unit -> Unit
129+ Just query' -> Optimized query'
130+
131+
132+primSelect :: Opaleye.PrimQuery' Void -> Opaleye.Select
133+primSelect = Opaleye.foldPrimQuery Opaleye.sqlQueryGenerator
134+
135+
136+primSelectWith :: Selects names exprs
137+ => names -> exprs -> Opaleye.PrimQuery' Void -> Opaleye.Select
138+primSelectWith names exprs query =
139+ Opaleye.SelectFrom $ Opaleye.newSelect
140+ { Opaleye.attrs = Opaleye.SelectAttrs attrs
141+ , Opaleye.tables = Opaleye.oneTable (primSelect query)
142+ }
143+ where
144+ attrs = makeAttr <$> exprsWithNames names (castTable exprs)
145+ where
146+ makeAttr (label, expr) =
147+ (Opaleye.sqlExpr expr, Just (Opaleye.SqlColumn label))
src/Rel8/Statement/Set.hsnew file+33
@@ -0,0 +1,33 @@
1+{-# language MonoLocalBinds #-}
2+{-# language NamedFieldPuns #-}
3+
4+module Rel8.Statement.Set
5+ ( ppSet
6+ )
7+where
8+
9+-- base
10+import Data.Foldable ( toList )
11+import Prelude ()
12+
13+-- opaleye
14+import qualified Opaleye.Internal.HaskellDB.Sql.Print as Opaleye
15+import qualified Opaleye.Internal.Sql as Opaleye
16+
17+-- pretty
18+import Text.PrettyPrint ( Doc, (<+>), equals, text )
19+
20+-- rel8
21+import Rel8.Schema.Name ( Selects, ppColumn )
22+import Rel8.Schema.Table ( TableSchema(..) )
23+import Rel8.Table.Opaleye ( attributes, exprsWithNames )
24+
25+
26+ppSet :: Selects names exprs
27+ => TableSchema names -> (exprs -> exprs) -> Doc
28+ppSet schema@TableSchema {columns} f =
29+ text "SET" <+> Opaleye.commaV ppAssign (toList assigns)
30+ where
31+ assigns = exprsWithNames columns (f (attributes schema))
32+ ppAssign (column, expr) =
33+ ppColumn column <+> equals <+> Opaleye.ppSqlExpr (Opaleye.sqlExpr expr)
src/Rel8/Statement/Update.hs+38−60
@@ -1,43 +1,37 @@
1+{-# language DuplicateRecordFields #-}
1{-# language GADTs #-}
2{-# language GADTs #-}
2{-# language NamedFieldPuns #-}
3{-# language NamedFieldPuns #-}
3−{-# language ScopedTypeVariables #-}
4+{-# language RecordWildCards #-}
4{-# language StandaloneKindSignatures #-}
5{-# language StandaloneKindSignatures #-}
5−{-# language TypeApplications #-}
6+{-# language StrictData #-}
6
7
7module Rel8.Statement.Update
8module Rel8.Statement.Update
8 ( Update(..)
9 ( Update(..)
9 , update
10 , update
11+ , ppUpdate
10 )
12 )
11where
13where
12
14
13-- base
15-- base
14−import Control.Exception ( throwIO )
15import Data.Kind ( Type )
16import Data.Kind ( Type )
16import Prelude
17import Prelude
17
18
18-- hasql
19-- hasql
19−import Hasql.Connection ( Connection )
20−import qualified Hasql.Decoders as Hasql
21import qualified Hasql.Encoders as Hasql
20import qualified Hasql.Encoders as Hasql
22−import qualified Hasql.Session as Hasql
23import qualified Hasql.Statement as Hasql
21import qualified Hasql.Statement as Hasql
24
22
25−-- opaleye
23+-- pretty
26−import qualified Opaleye.Internal.Manipulation as Opaleye
24+import Text.PrettyPrint ( Doc, (<+>), ($$), text )
27−
28−-- profunctors
29−import Data.Profunctor ( lmap )
30
25
31-- rel8
26-- rel8
32import Rel8.Expr ( Expr )
27import Rel8.Expr ( Expr )
33−import Rel8.Expr.Opaleye ( toColumn, toPrimExpr )
28+import Rel8.Query ( Query )
34import Rel8.Schema.Name ( Selects )
29import Rel8.Schema.Name ( Selects )
35−import Rel8.Schema.Table ( TableSchema )
30+import Rel8.Schema.Table ( TableSchema(..), ppTable )
36−import Rel8.Statement.Returning ( Returning( Projection, NumberOfRowsAffected ) )
31+import Rel8.Statement.Returning ( Returning, decodeReturning, ppReturning )
37−import Rel8.Table ( fromColumns, toColumns )
32+import Rel8.Statement.Set ( ppSet )
38−import Rel8.Table.Insert ( toInsert )
33+import Rel8.Statement.Using ( ppFrom )
39−import Rel8.Table.Opaleye ( castTable, table, unpackspec )
34+import Rel8.Statement.Where ( ppWhere )
40−import Rel8.Table.Serialize ( Serializable, parse )
41
35
42-- text
36-- text
43import qualified Data.Text as Text
37import qualified Data.Text as Text
@@ -50,9 +44,12 @@ data Update a where
50 Update :: Selects names exprs =>
44 Update :: Selects names exprs =>
51 { target :: TableSchema names
45 { target :: TableSchema names
52 -- ^ Which table to update.
46 -- ^ Which table to update.
53− , set :: exprs -> exprs
47+ , from :: Query from
48+ -- ^ @FROM@ clause — this can be used to join against other tables,
49+ -- and its results can be referenced in the @SET@ and @WHERE@ clauses.
50+ , set :: from -> exprs -> exprs
54 -- ^ How to update each selected row.
51 -- ^ How to update each selected row.
55− , updateWhere :: exprs -> Expr Bool
52+ , updateWhere :: from -> exprs -> Expr Bool
56 -- ^ Which rows to select for update.
53 -- ^ Which rows to select for update.
57 , returning :: Returning names a
54 , returning :: Returning names a
58 -- ^ What to return from the @UPDATE@ statement.
55 -- ^ What to return from the @UPDATE@ statement.
@@ -60,46 +57,27 @@ data Update a where
60 -> Update a
57 -> Update a
61
58
62
59
63−-- | Run an @UPDATE@ statement.
60+ppUpdate :: Update a -> Doc
64−update :: Connection -> Update a -> IO a
61+ppUpdate Update {..} = case ppFrom from of
65−update c Update {target, set, updateWhere, returning} =
62+ Nothing ->
66− case returning of
63+ text "UPDATE" <+> ppTable target $$
67− NumberOfRowsAffected -> Hasql.run session c >>= either throwIO pure
64+ ppSet target id $$
68− where
65+ text "WHERE false"
69− session = Hasql.statement () statement
66+ Just (fromDoc, i) ->
70− statement = Hasql.Statement bytes params decode prepare
67+ text "UPDATE" <+> ppTable target $$
71− bytes = encodeUtf8 $ Text.pack sql
68+ ppSet target (set i) $$
72− params = Hasql.noParams
69+ fromDoc $$
73− decode = Hasql.rowsAffected
70+ ppWhere target (updateWhere i) $$
74− prepare = False
71+ ppReturning target returning
75− sql = Opaleye.arrangeUpdateSql target' set' where'
76− where
77− target' = lmap toInsert $ table $ toColumns <$> target
78− set' = toColumns . set . fromColumns
79− where' = toColumn . toPrimExpr . updateWhere . fromColumns
80
72
81− Projection project -> Hasql.run session c >>= either throwIO pure
82− where
83− session = Hasql.statement () statement
84− statement = Hasql.Statement bytes params decode prepare
85− bytes = encodeUtf8 $ Text.pack sql
86− params = Hasql.noParams
87− decode = decoder project
88− prepare = False
89− sql =
90− Opaleye.arrangeUpdateReturningSql
91− unpackspec
92− target'
93− set'
94− where'
95− project'
96− where
97− target' = lmap toInsert $ table $ toColumns <$> target
98− set' = toColumns . set . fromColumns
99− where' = toColumn . toPrimExpr . updateWhere . fromColumns
100− project' = castTable . toColumns . project . fromColumns
101
73
74+-- | Run an @UPDATE@ statement.
75+update :: Update a -> Hasql.Statement () a
76+update u@Update {returning} = Hasql.Statement bytes params decode prepare
102 where
77 where
103− decoder :: forall exprs projection a. Serializable projection a
78+ bytes = encodeUtf8 $ Text.pack sql
104− => (exprs -> projection) -> Hasql.Result [a]
79+ params = Hasql.noParams
105− decoder _ = Hasql.rowList (parse @projection @a)
80+ decode = decodeReturning returning
81+ prepare = False
82+ sql = show doc
83+ doc = ppUpdate u
src/Rel8/Statement/Using.hsnew file+36
@@ -0,0 +1,36 @@
1+module Rel8.Statement.Using
2+ ( ppFrom
3+ , ppUsing
4+ )
5+where
6+
7+-- base
8+import Prelude
9+
10+-- pretty
11+import Text.PrettyPrint ( Doc, (<+>), parens, text )
12+
13+-- rel8
14+import Rel8.Query ( Query )
15+import Rel8.Schema.Table ( TableSchema(..), ppTable )
16+import Rel8.Statement.Select ( Optimized(..), ppPrimSelect )
17+
18+
19+ppFrom :: Query a -> Maybe (Doc, a)
20+ppFrom = ppJoin "FROM"
21+
22+
23+ppUsing :: Query a -> Maybe (Doc, a)
24+ppUsing = ppJoin "USING"
25+
26+
27+ppJoin :: String -> Query a -> Maybe (Doc, a)
28+ppJoin clause join = do
29+ doc <- case ofrom of
30+ Empty -> Nothing
31+ Unit -> Just mempty
32+ Optimized doc -> Just $ text clause <+> parens doc <+> ppTable alias
33+ pure (doc, a)
34+ where
35+ alias = TableSchema {name = "T1", schema = Nothing, columns = ()}
36+ (ofrom, a) = ppPrimSelect join
src/Rel8/Statement/View.hs+43−28
@@ -3,61 +3,76 @@
3
3
4module Rel8.Statement.View
4module Rel8.Statement.View
5 ( createView
5 ( createView
6+ , createOrReplaceView
6 )
7 )
7where
8where
8
9
9-- base
10-- base
10−import Control.Exception ( throwIO )
11−import Control.Monad ( (>=>) )
12−import Data.Foldable ( fold )
13−import Data.Maybe ( fromMaybe )
14import Prelude
11import Prelude
15
12
16-- hasql
13-- hasql
17−import Hasql.Connection ( Connection )
18import qualified Hasql.Decoders as Hasql
14import qualified Hasql.Decoders as Hasql
19import qualified Hasql.Encoders as Hasql
15import qualified Hasql.Encoders as Hasql
20−import qualified Hasql.Session as Hasql
21import qualified Hasql.Statement as Hasql
16import qualified Hasql.Statement as Hasql
22
17
23-- rel8
18-- rel8
24import Rel8.Query ( Query )
19import Rel8.Query ( Query )
25−import Rel8.Query.SQL ( sqlForQueryWithNames )
26import Rel8.Schema.Name ( Selects )
20import Rel8.Schema.Name ( Selects )
27−import Rel8.Schema.Table ( TableSchema( TableSchema ) )
21+import Rel8.Schema.Table ( TableSchema )
28−import Rel8.Table.Alternative ( emptyTable )
22+import Rel8.Statement.Insert ( ppInto )
23+import Rel8.Statement.Select ( ppSelect )
24+
25+-- pretty
26+import Text.PrettyPrint ( Doc, (<+>), ($$), text )
29
27
30-- text
28-- text
31import qualified Data.Text as Text
29import qualified Data.Text as Text
32import Data.Text.Encoding ( encodeUtf8 )
30import Data.Text.Encoding ( encodeUtf8 )
33
31
34
32
33+data CreateView = Create | CreateOrReplace
34+
35+
35-- | Given a 'TableSchema' and 'Query', @createView@ runs a @CREATE VIEW@
36-- | Given a 'TableSchema' and 'Query', @createView@ runs a @CREATE VIEW@
36-- statement that will save the given query as a view. This can be useful if
37-- statement that will save the given query as a view. This can be useful if
37-- you want to share Rel8 queries with other applications.
38-- you want to share Rel8 queries with other applications.
38createView :: Selects names exprs
39createView :: Selects names exprs
39− => TableSchema names -> Query exprs -> Connection -> IO ()
40+ => TableSchema names -> Query exprs -> Hasql.Statement () ()
40−createView (TableSchema name mschema names) query =
41+createView =
41− Hasql.run session >=> either throwIO pure
42+ createViewGeneric Create
43+
44+
45+-- | Given a 'TableSchema' and 'Query', @createOrReplaceView@ runs a
46+-- @CREATE OR REPLACE VIEW@ statement that will save the given query
47+-- as a view, replacing the current view definition if it exists and
48+-- adheres to the restrictions in place for replacing a view in
49+-- PostgreSQL.
50+createOrReplaceView :: Selects names exprs
51+ => TableSchema names -> Query exprs -> Hasql.Statement () ()
52+createOrReplaceView =
53+ createViewGeneric CreateOrReplace
54+
55+
56+createViewGeneric :: Selects names exprs
57+ => CreateView -> TableSchema names -> Query exprs -> Hasql.Statement () ()
58+createViewGeneric replace schema query =
59+ Hasql.Statement bytes params decode prepare
42 where
60 where
43− session = Hasql.statement () statement
44− statement = Hasql.Statement bytes params decode prepare
45 bytes = encodeUtf8 (Text.pack sql)
61 bytes = encodeUtf8 (Text.pack sql)
46 params = Hasql.noParams
62 params = Hasql.noParams
47 decode = Hasql.noResult
63 decode = Hasql.noResult
48 prepare = False
64 prepare = False
49− sql = "CREATE VIEW " <> title <> " AS " <> select
65+ sql = show doc
50− where
66+ doc = ppCreateView schema query replace
51− title = case mschema of
67+
52− Nothing -> quote name
68+
53− Just schema -> quote schema <> "." <> quote name
69+ppCreateView :: Selects names exprs
54− select = fromMaybe fallback $ sqlForQueryWithNames names query
70+ => TableSchema names -> Query exprs -> CreateView -> Doc
55− where
71+ppCreateView schema query replace =
56− fallback = fold $ sqlForQueryWithNames names emptyTable
72+ createOrReplace replace <+>
57−
73+ ppInto schema $$
58−
74+ text "AS" <+>
59−quote :: String -> String
75+ ppSelect query
60−quote string = "\"" <> concatMap go string <> "\""
61 where
76 where
62− go '"' = "\"\""
77+ createOrReplace Create = text "CREATE VIEW"
63− go c = [c]
78+ createOrReplace CreateOrReplace = text "CREATE OR REPLACE VIEW"
src/Rel8/Statement/Where.hsnew file+31
@@ -0,0 +1,31 @@
1+{-# language MonoLocalBinds #-}
2+
3+module Rel8.Statement.Where
4+ ( ppWhere
5+ )
6+where
7+
8+-- base
9+import Prelude
10+
11+-- opaleye
12+import qualified Opaleye.Internal.HaskellDB.Sql.Print as Opaleye
13+import qualified Opaleye.Internal.Sql as Opaleye
14+
15+-- pretty
16+import Text.PrettyPrint ( Doc, (<+>), text )
17+
18+-- rel8
19+import Rel8.Expr ( Expr )
20+import Rel8.Expr.Opaleye ( toPrimExpr )
21+import Rel8.Schema.Name ( Selects )
22+import Rel8.Schema.Table ( TableSchema )
23+import Rel8.Table.Opaleye ( attributes )
24+
25+
26+ppWhere :: Selects names exprs
27+ => TableSchema names -> (exprs -> Expr Bool) -> Doc
28+ppWhere schema where_ = text "WHERE" <+> ppExpr condition
29+ where
30+ ppExpr = Opaleye.ppSqlExpr . Opaleye.sqlExpr . toPrimExpr
31+ condition = where_ (attributes schema)
src/Rel8/Table.hs+84−283
@@ -1,71 +1,47 @@
1{-# language AllowAmbiguousTypes #-}
1{-# language AllowAmbiguousTypes #-}
2{-# language DataKinds #-}
2{-# language DataKinds #-}
3{-# language DefaultSignatures #-}
3{-# language DefaultSignatures #-}
4−{-# language DisambiguateRecordFields #-}
5{-# language FlexibleContexts #-}
4{-# language FlexibleContexts #-}
6{-# language FlexibleInstances #-}
5{-# language FlexibleInstances #-}
7{-# language FunctionalDependencies #-}
6{-# language FunctionalDependencies #-}
8−{-# language LambdaCase #-}
9−{-# language NamedFieldPuns #-}
10{-# language ScopedTypeVariables #-}
7{-# language ScopedTypeVariables #-}
11{-# language StandaloneKindSignatures #-}
8{-# language StandaloneKindSignatures #-}
12{-# language TypeApplications #-}
9{-# language TypeApplications #-}
13{-# language TypeFamilies #-}
10{-# language TypeFamilies #-}
14−{-# language TypeOperators #-}
15{-# language UndecidableInstances #-}
11{-# language UndecidableInstances #-}
16
12
17module Rel8.Table
13module Rel8.Table
18− ( Table (Columns, Context, Unreify, toColumns, fromColumns, reify, unreify)
14+ ( Table
15+ ( Columns, Context, fromColumns, toColumns
16+ , FromExprs, fromResult, toResult
17+ , Transpose
18+ )
19 , Congruent
19 , Congruent
20− , TTable, TColumns, TContext, TUnreify
20+ , TTable, TColumns, TContext, TFromExprs, TTranspose
21+ , TSerialize
21 )
22 )
22where
23where
23
24
24-- base
25-- base
25−import Data.Functor ( ($>) )
26import Data.Functor.Identity ( Identity( Identity ) )
26import Data.Functor.Identity ( Identity( Identity ) )
27import Data.Kind ( Constraint, Type )
27import Data.Kind ( Constraint, Type )
28−import Data.List.NonEmpty ( NonEmpty )
29−import Data.Proxy ( Proxy( Proxy ) )
30−import Data.Type.Equality ( (:~:)( Refl ) )
31import GHC.Generics ( Generic, Rep, from, to )
28import GHC.Generics ( Generic, Rep, from, to )
32import Prelude hiding ( null )
29import Prelude hiding ( null )
33
30
34-- rel8
31-- rel8
35import Rel8.FCF ( Eval, Exp )
32import Rel8.FCF ( Eval, Exp )
36−import Rel8.Generic.Map ( GMap, GMappable, gmap, gunmap )
33+import Rel8.Generic.Map ( Map )
37−import Rel8.Generic.Table
34+import Rel8.Generic.Table.Record
38− ( GTable, GColumns, GContext, fromGColumns, toGColumns
35+ ( GTable, GColumns, GContext, gfromColumns, gtoColumns
36+ , GSerialize, gfromResult, gtoResult
39 )
37 )
40import Rel8.Generic.Record ( Record(..) )
38import Rel8.Generic.Record ( Record(..) )
41−import Rel8.Schema.Context ( Col(..) )
42−import Rel8.Schema.Context.Label ( Labelable, labeler, unlabeler )
43import Rel8.Schema.HTable ( HTable )
39import Rel8.Schema.HTable ( HTable )
44−import Rel8.Schema.HTable.Either ( HEitherTable(..) )
40+import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
45−import Rel8.Schema.HTable.Identity ( HIdentity(..) )
46−import Rel8.Schema.HTable.Label ( hlabel, hunlabel )
47−import Rel8.Schema.HTable.List ( HListTable )
48−import Rel8.Schema.HTable.Maybe ( HMaybeTable(..) )
49−import Rel8.Schema.HTable.NonEmpty ( HNonEmptyTable )
50−import Rel8.Schema.HTable.Nullify ( hnulls, hnullify, hunnullify )
51−import Rel8.Schema.HTable.These ( HTheseTable(..) )
52−import Rel8.Schema.HTable.Type ( HType( HType ) )
53−import Rel8.Schema.HTable.Vectorize ( hvectorize, hunvectorize )
54import qualified Rel8.Schema.Kind as K
41import qualified Rel8.Schema.Kind as K
55−import Rel8.Schema.Null ( Nullify, Nullity( Null, NotNull ), Sql )
42+import Rel8.Schema.Null ( Sql )
56−import Rel8.Schema.Reify
57− ( Reify, Col( Reify ), hreify, hunreify
58− , UnwrapReify
59− , notReify
60− )
61import Rel8.Schema.Result ( Result )
43import Rel8.Schema.Result ( Result )
62−import Rel8.Schema.Spec ( Spec( Spec ), SSpec(..), KnownSpec )
63import Rel8.Type ( DBType )
44import Rel8.Type ( DBType )
64−import Rel8.Type.Tag ( EitherTag( IsLeft, IsRight ), MaybeTag( IsJust ) )
65−
66−-- these
67−import Data.These ( These( This, That, These ) )
68−import Data.These.Combinators ( justHere, justThere )
69
45
70
46
71-- | @Table@s are one of the foundational elements of Rel8, and describe data
47-- | @Table@s are one of the foundational elements of Rel8, and describe data
@@ -80,74 +56,102 @@ import Data.These.Combinators ( justHere, justThere )
80-- yourself, as anything that's an instance of 'Rel8.Rel8able' is always a
56-- yourself, as anything that's an instance of 'Rel8.Rel8able' is always a
81-- 'Table'.
57-- 'Table'.
82type Table :: K.Context -> Type -> Constraint
58type Table :: K.Context -> Type -> Constraint
83−class (HTable (Columns a), context ~ Context a) => Table context a | a -> context where
59+class
60+ ( HTable (Columns a)
61+ , context ~ Context a
62+ , a ~ Transpose context a
63+ )
64+ => Table context a | a -> context
65+ where
84 -- | The 'HTable' functor that describes the schema of this table.
66 -- | The 'HTable' functor that describes the schema of this table.
85 type Columns a :: K.HTable
67 type Columns a :: K.HTable
86
68
87 -- | The common context that all columns use as an interpretation.
69 -- | The common context that all columns use as an interpretation.
88 type Context a :: K.Context
70 type Context a :: K.Context
89
71
90− type Unreify a :: Type
72+ -- | The @FromExprs@ type family maps a type in the @Expr@ context to the
73+ -- corresponding Haskell type.
74+ type FromExprs a :: Type
91
75
92− toColumns :: a -> Columns a (Col context)
76+ type Transpose (context' :: K.Context) a :: Type
93− fromColumns :: Columns a (Col context) -> a
94
77
95− reify :: context :~: Reify ctx -> Unreify a -> a
78+
96− unreify :: context :~: Reify ctx -> a -> Unreify a
79+ toColumns :: a -> Columns a context
80+ fromColumns :: Columns a context -> a
81+
82+ fromResult :: Columns a Result -> FromExprs a
83+ toResult :: FromExprs a -> Columns a Result
97
84
98 type Columns a = GColumns TColumns (Rep (Record a))
85 type Columns a = GColumns TColumns (Rep (Record a))
99 type Context a = GContext TContext (Rep (Record a))
86 type Context a = GContext TContext (Rep (Record a))
100− type Unreify a = DefaultUnreify a
87+ type FromExprs a = Map TFromExprs a
88+ type Transpose context a = Map (TTranspose context) a
101
89
102 default toColumns ::
90 default toColumns ::
103 ( Generic (Record a)
91 ( Generic (Record a)
104− , GTable (TTable context) TColumns (Col context) (Rep (Record a))
92+ , GTable (TTable context) TColumns (Rep (Record a))
105 , Columns a ~ GColumns TColumns (Rep (Record a))
93 , Columns a ~ GColumns TColumns (Rep (Record a))
106 )
94 )
107− => a -> Columns a (Col context)
95+ => a -> Columns a context
108 toColumns =
96 toColumns =
109− toGColumns @(TTable context) @TColumns toColumns .
97+ gtoColumns @(TTable context) @TColumns toColumns .
110 from .
98 from .
111 Record
99 Record
112
100
113 default fromColumns ::
101 default fromColumns ::
114 ( Generic (Record a)
102 ( Generic (Record a)
115− , GTable (TTable context) TColumns (Col context) (Rep (Record a))
103+ , GTable (TTable context) TColumns (Rep (Record a))
116 , Columns a ~ GColumns TColumns (Rep (Record a))
104 , Columns a ~ GColumns TColumns (Rep (Record a))
117 )
105 )
118− => Columns a (Col context) -> a
106+ => Columns a context -> a
119 fromColumns =
107 fromColumns =
120 unrecord .
108 unrecord .
121 to .
109 to .
122− fromGColumns @(TTable context) @TColumns fromColumns
110+ gfromColumns @(TTable context) @TColumns fromColumns
123
111
124− default reify ::
112+ default toResult ::
125− ( Generic (Record a)
113+ ( Generic (Record (FromExprs a))
126− , Generic (Record (Unreify a))
114+ , GSerialize TSerialize TColumns (Rep (Record a)) (Rep (Record (FromExprs a)))
127− , GMappable (TTable context) (Rep (Record a))
115+ , Columns a ~ GColumns TColumns (Rep (Record a))
128− , Rep (Record (Unreify a)) ~ GMap TUnreify (Rep (Record a))
129 )
116 )
130− => context :~: Reify ctx -> Unreify a -> a
117+ => FromExprs a -> Columns a Result
131− reify Refl =
118+ toResult =
132− unrecord .
119+ gtoResult
133− to .
120+ @TSerialize
134− gunmap @(TTable context) (Proxy @TUnreify) (reify Refl) .
121+ @TColumns
122+ @(Rep (Record a))
123+ @(Rep (Record (FromExprs a)))
124+ (\(_ :: proxy x) -> toResult @(Context x) @x) .
135 from .
125 from .
136 Record
126 Record
137
127
138− default unreify ::
128+ default fromResult ::
139− ( Generic (Record a)
129+ ( Generic (Record (FromExprs a))
140− , Generic (Record (Unreify a))
130+ , GSerialize TSerialize TColumns (Rep (Record a)) (Rep (Record (FromExprs a)))
141− , GMappable (TTable context) (Rep (Record a))
131+ , Columns a ~ GColumns TColumns (Rep (Record a))
142− , Rep (Record (Unreify a)) ~ GMap TUnreify (Rep (Record a))
143 )
132 )
144− => context :~: Reify ctx -> a -> Unreify a
133+ => Columns a Result -> FromExprs a
145− unreify Refl =
134+ fromResult =
146 unrecord .
135 unrecord .
147 to .
136 to .
148− gmap @(TTable context) (Proxy @TUnreify) (unreify Refl) .
137+ gfromResult
149− from .
138+ @TSerialize
150− Record
139+ @TColumns
140+ @(Rep (Record a))
141+ @(Rep (Record (FromExprs a)))
142+ (\(_ :: proxy x) -> fromResult @(Context x) @x)
143+
144+
145+instance Sql DBType a => Table Result (Identity a) where
146+ type Columns (Identity a) = HIdentity a
147+ type Context (Identity a) = Result
148+ type FromExprs (Identity a) = a
149+ type Transpose to (Identity a) = to a
150+
151+ toColumns = HIdentity
152+ fromColumns (HIdentity a) = a
153+ toResult a = HIdentity (Identity a)
154+ fromResult (HIdentity (Identity a)) = a
151
155
152
156
153data TTable :: K.Context -> Type -> Exp Constraint
157data TTable :: K.Context -> Type -> Exp Constraint
@@ -162,189 +166,32 @@ data TContext :: Type -> Exp K.Context
162type instance Eval (TContext a) = Context a
166type instance Eval (TContext a) = Context a
163
167
164
168
165−data TUnreify :: Type -> Exp Type
169+data TFromExprs :: Type -> Exp Type
166−type instance Eval (TUnreify a) = Unreify a
170+type instance Eval (TFromExprs a) = FromExprs a
167−
168−
169−type DefaultUnreify :: Type -> Type
170−type family DefaultUnreify a where
171− DefaultUnreify (t a b c d e f g) =
172− t (Unreify a) (Unreify b) (Unreify c) (Unreify d) (Unreify e) (Unreify f) (Unreify g)
173− DefaultUnreify (t a b c d e f) =
174− t (Unreify a) (Unreify b) (Unreify c) (Unreify d) (Unreify e) (Unreify f)
175− DefaultUnreify (t a b c d e) =
176− t (Unreify a) (Unreify b) (Unreify c) (Unreify d) (Unreify e)
177− DefaultUnreify (t a b c d) =
178− t (Unreify a) (Unreify b) (Unreify c) (Unreify d)
179− DefaultUnreify (t a b c) = t (Unreify a) (Unreify b) (Unreify c)
180− DefaultUnreify (t a b) = t (Unreify a) (Unreify b)
181− DefaultUnreify (t a) = t (Unreify a)
182
171
183
172
184−-- | Any 'HTable' is also a 'Table'.
173+data TTranspose :: K.Context -> Type -> Exp Type
185−instance HTable t => Table context (t (Col context)) where
174+type instance Eval (TTranspose context a) = Transpose context a
186− type Columns (t (Col context)) = t
187− type Context (t (Col context)) = context
188− type Unreify (t (Col context)) = t (Col (UnwrapReify context))
189
175
190− toColumns = id
191− fromColumns = id
192−
193− reify Refl = hreify
194− unreify Refl = hunreify
195−
196−
197−-- | Any context is trivially a table.
198−instance KnownSpec spec => Table context (Col context spec) where
199− type Columns (Col context spec) = HIdentity spec
200− type Context (Col context spec) = context
201− type Unreify (Col context spec) = Col (UnwrapReify context) spec
202−
203− toColumns = HIdentity
204− fromColumns = unHIdentity
205−
206− reify Refl = Reify
207− unreify Refl (Reify a) = a
208
176
177+data TSerialize :: Type -> Type -> Exp Constraint
178+type instance Eval (TSerialize expr a) =
179+ ( Table (Context expr) expr
180+ , a ~ FromExprs expr
181+ )
209
182
210−instance Sql DBType a => Table Result (Identity a) where
211− type Columns (Identity a) = HType a
212− type Context (Identity a) = Result
213
183
214− toColumns (Identity a) = HType (Result a)
184+instance (Table context a, Table context b) => Table context (a, b)
215− fromColumns (HType (Result a)) = Identity a
216−
217− reify = notReify
218− unreify = notReify
219−
220−
221−instance (Table Result a, Table Result b) => Table Result (Either a b) where
222− type Columns (Either a b) = HEitherTable (Columns a) (Columns b)
223− type Context (Either a b) = Result
224−
225− toColumns = \case
226− Left table -> HEitherTable
227− { htag = HIdentity (Result IsLeft)
228− , hleft = hlabel labeler (hnullify nullifier (toColumns table))
229− , hright = hlabel labeler (hnulls null)
230− }
231− Right table -> HEitherTable
232− { htag = HIdentity (Result IsRight)
233− , hleft = hlabel labeler (hnulls null)
234− , hright = hlabel labeler (hnullify nullifier (toColumns table))
235− }
236−
237− fromColumns HEitherTable {htag, hleft, hright} = case htag of
238− HIdentity (Result tag) -> case tag of
239− IsLeft -> maybe err (Left . fromColumns) $ hunnullify unnullifier (hunlabel unlabeler hleft)
240− IsRight -> maybe err (Right . fromColumns) $ hunnullify unnullifier (hunlabel unlabeler hright)
241− where
242− err = error "Either.fromColumns: mismatch between tag and data"
243−
244− reify = notReify
245− unreify = notReify
246−
247−
248−instance Table Result a => Table Result [a] where
249− type Columns [a] = HListTable (Columns a)
250− type Context [a] = Result
251−
252− toColumns = hvectorize vectorizer . fmap toColumns
253− fromColumns = fmap fromColumns . hunvectorize unvectorizer
254−
255− reify = notReify
256− unreify = notReify
257−
258−
259−instance Table Result a => Table Result (Maybe a) where
260− type Columns (Maybe a) = HMaybeTable (Columns a)
261− type Context (Maybe a) = Result
262−
263− toColumns = \case
264− Nothing -> HMaybeTable
265− { htag = HIdentity (Result Nothing)
266− , hjust = hlabel labeler (hnulls null)
267− }
268− Just table -> HMaybeTable
269− { htag = HIdentity (Result (Just IsJust))
270− , hjust = hlabel labeler (hnullify nullifier (toColumns table))
271− }
272−
273− fromColumns HMaybeTable {htag, hjust} = case htag of
274− HIdentity (Result tag) -> tag $>
275− case hunnullify unnullifier (hunlabel unlabeler hjust) of
276− Nothing -> error "Maybe.fromColumns: mismatch between tag and data"
277− Just just -> fromColumns just
278−
279− reify = notReify
280− unreify = notReify
281−
282−
283−instance Table Result a => Table Result (NonEmpty a) where
284− type Columns (NonEmpty a) = HNonEmptyTable (Columns a)
285− type Context (NonEmpty a) = Result
286−
287− toColumns = hvectorize vectorizer . fmap toColumns
288− fromColumns = fmap fromColumns . hunvectorize unvectorizer
289−
290− reify = notReify
291− unreify = notReify
292−
293−
294−instance (Table Result a, Table Result b) => Table Result (These a b) where
295− type Columns (These a b) = HTheseTable (Columns a) (Columns b)
296− type Context (These a b) = Result
297−
298− toColumns tables = HTheseTable
299− { hhereTag = relabel hhereTag
300− , hhere = hlabel labeler (hunlabel unlabeler (toColumns hhere))
301− , hthereTag = relabel hthereTag
302− , hthere = hlabel labeler (hunlabel unlabeler (toColumns hthere))
303− }
304− where
305− HMaybeTable
306− { htag = hhereTag
307− , hjust = hhere
308− } = toColumns (justHere tables)
309− HMaybeTable
310− { htag = hthereTag
311− , hjust = hthere
312− } = toColumns (justThere tables)
313−
314− fromColumns HTheseTable {hhereTag, hhere, hthereTag, hthere} =
315− case (fromColumns mhere, fromColumns mthere) of
316− (Just a, Nothing) -> This (fromColumns a)
317− (Nothing, Just b) -> That (fromColumns b)
318− (Just a, Just b) -> These (fromColumns a) (fromColumns b)
319− _ -> error "These.fromColumns: mismatch between tags and data"
320− where
321− mhere = HMaybeTable
322− { htag = relabel hhereTag
323− , hjust = hlabel labeler (hunlabel unlabeler hhere)
324− }
325− mthere = HMaybeTable
326− { htag = relabel hthereTag
327− , hjust = hlabel labeler (hunlabel unlabeler hthere)
328− }
329−
330− reify = notReify
331− unreify = notReify
332−
333−
334−instance (Table context a, Table context b, Labelable context)
335− => Table context (a, b)
336
185
337
186
338instance
187instance
339 ( Table context a, Table context b, Table context c
188 ( Table context a, Table context b, Table context c
340− , Labelable context
341 )
189 )
342 => Table context (a, b, c)
190 => Table context (a, b, c)
343
191
344
192
345instance
193instance
346 ( Table context a, Table context b, Table context c, Table context d
194 ( Table context a, Table context b, Table context c, Table context d
347− , Labelable context
348 )
195 )
349 => Table context (a, b, c, d)
196 => Table context (a, b, c, d)
350
197
@@ -352,7 +199,6 @@ instance
352instance
199instance
353 ( Table context a, Table context b, Table context c, Table context d
200 ( Table context a, Table context b, Table context c, Table context d
354 , Table context e
201 , Table context e
355− , Labelable context
356 )
202 )
357 => Table context (a, b, c, d, e)
203 => Table context (a, b, c, d, e)
358
204
@@ -360,7 +206,6 @@ instance
360instance
206instance
361 ( Table context a, Table context b, Table context c, Table context d
207 ( Table context a, Table context b, Table context c, Table context d
362 , Table context e, Table context f
208 , Table context e, Table context f
363− , Labelable context
364 )
209 )
365 => Table context (a, b, c, d, e, f)
210 => Table context (a, b, c, d, e, f)
366
211
@@ -368,7 +213,6 @@ instance
368instance
213instance
369 ( Table context a, Table context b, Table context c, Table context d
214 ( Table context a, Table context b, Table context c, Table context d
370 , Table context e, Table context f, Table context g
215 , Table context e, Table context f, Table context g
371− , Labelable context
372 )
216 )
373 => Table context (a, b, c, d, e, f, g)
217 => Table context (a, b, c, d, e, f, g)
374
218
@@ -376,46 +220,3 @@ instance
376type Congruent :: Type -> Type -> Constraint
220type Congruent :: Type -> Type -> Constraint
377class Columns a ~ Columns b => Congruent a b
221class Columns a ~ Columns b => Congruent a b
378instance Columns a ~ Columns b => Congruent a b
222instance Columns a ~ Columns b => Congruent a b
379−
380−
381−null :: Col Result ('Spec labels necessity (Maybe a))
382−null = Result Nothing
383−
384−
385−nullifier :: ()
386− => SSpec ('Spec labels necessity a)
387− -> Col Result ('Spec labels necessity a)
388− -> Col Result ('Spec labels necessity (Nullify a))
389−nullifier SSpec {nullity} (Result a) = Result $ case nullity of
390− Null -> a
391− NotNull -> Just a
392−
393−
394−unnullifier :: ()
395− => SSpec ('Spec labels necessity a)
396− -> Col Result ('Spec labels necessity (Nullify a))
397− -> Maybe (Col Result ('Spec labels necessity a))
398−unnullifier SSpec {nullity} (Result a) =
399− case nullity of
400− Null -> pure $ Result a
401− NotNull -> Result <$> a
402−
403−
404−vectorizer :: Functor f
405− => SSpec ('Spec labels necessity a)
406− -> f (Col Result ('Spec labels necessity a))
407− -> Col Result ('Spec labels necessity (f a))
408−vectorizer _ = Result . fmap (\(Result a) -> a)
409−
410−
411−unvectorizer :: Functor f
412− => SSpec ('Spec labels necessity a)
413− -> Col Result ('Spec labels necessity (f a))
414− -> f (Col Result ('Spec labels necessity a))
415−unvectorizer _ (Result results) = Result <$> results
416−
417−
418−relabel :: ()
419− => HIdentity ('Spec labels necessity a) (Col Result)
420− -> HIdentity ('Spec relabels necessity a) (Col Result)
421−relabel (HIdentity (Result a)) = HIdentity (Result a)
src/Rel8/Table/ADT.hsnew file+173
@@ -0,0 +1,173 @@
1+{-# language AllowAmbiguousTypes #-}
2+{-# language DataKinds #-}
3+{-# language FlexibleContexts #-}
4+{-# language FlexibleInstances #-}
5+{-# language MultiParamTypeClasses #-}
6+{-# language RankNTypes #-}
7+{-# language ScopedTypeVariables #-}
8+{-# language StandaloneKindSignatures #-}
9+{-# language TypeApplications #-}
10+{-# language TypeFamilyDependencies #-}
11+{-# language UndecidableInstances #-}
12+{-# language UndecidableSuperClasses #-}
13+
14+module Rel8.Table.ADT
15+ ( ADT( ADT )
16+ , ADTable
17+ , BuildableADT
18+ , BuildADT, buildADT
19+ , ConstructableADT
20+ , ConstructADT, constructADT
21+ , DeconstructADT, deconstructADT
22+ , NameADT, nameADT
23+ , AggregateADT, aggregateADT
24+ , ADTRep
25+ )
26+where
27+
28+-- base
29+import Data.Kind ( Constraint, Type )
30+import GHC.Generics ( Generic, from, to )
31+import GHC.TypeLits ( Symbol )
32+import Prelude
33+
34+-- rel8
35+import Rel8.Aggregate ( Aggregate )
36+import Rel8.Expr ( Expr )
37+import Rel8.FCF ( Eval, Exp )
38+import Rel8.Generic.Construction
39+ ( GGBuildable
40+ , GGBuild, ggbuild
41+ , GGConstructable
42+ , GGConstruct, ggconstruct
43+ , GGDeconstruct, ggdeconstruct
44+ , GGName, ggname
45+ , GGAggregate, ggaggregate
46+ )
47+import Rel8.Generic.Record ( Record( Record ), unrecord )
48+import Rel8.Generic.Rel8able
49+ ( Rel8able
50+ , GRep, GColumns, gfromColumns, gtoColumns
51+ , GFromExprs, gfromResult, gtoResult
52+ , TSerialize, deserialize, serialize
53+ )
54+import qualified Rel8.Generic.Table.ADT as G
55+import qualified Rel8.Kind.Algebra as K
56+import Rel8.Schema.HTable ( HTable )
57+import qualified Rel8.Schema.Kind as K
58+import Rel8.Schema.Name ( Name )
59+import Rel8.Schema.Result ( Result )
60+import Rel8.Table ( Table, TColumns )
61+
62+
63+type ADT :: K.Rel8able -> K.Rel8able
64+newtype ADT t context = ADT (GColumnsADT t context)
65+
66+
67+instance ADTable t => Rel8able (ADT t) where
68+ type GColumns (ADT t) = GColumnsADT t
69+ type GFromExprs (ADT t) = t Result
70+
71+ gfromColumns _ = ADT
72+ gtoColumns _ (ADT a) = a
73+
74+ gfromResult =
75+ unrecord .
76+ to .
77+ G.gfromResultADT
78+ @TSerialize
79+ @TColumns
80+ @(Eval (ADTRep t Expr))
81+ @(Eval (ADTRep t Result))
82+ (\(_ :: proxy x) -> deserialize @_ @x)
83+
84+ gtoResult =
85+ G.gtoResultADT
86+ @TSerialize
87+ @TColumns
88+ @(Eval (ADTRep t Expr))
89+ @(Eval (ADTRep t Result))
90+ (\(_ :: proxy x) -> serialize @_ @x) .
91+ from .
92+ Record
93+
94+
95+type ADTable :: K.Rel8able -> Constraint
96+class
97+ ( Generic (Record (t Result))
98+ , HTable (GColumnsADT t)
99+ , G.GSerializeADT TSerialize TColumns (Eval (ADTRep t Expr)) (Eval (ADTRep t Result))
100+ )
101+ => ADTable t
102+instance
103+ ( Generic (Record (t Result))
104+ , HTable (GColumnsADT t)
105+ , G.GSerializeADT TSerialize TColumns (Eval (ADTRep t Expr)) (Eval (ADTRep t Result))
106+ )
107+ => ADTable t
108+
109+
110+type BuildableADT :: K.Rel8able -> Symbol -> Constraint
111+class GGBuildable 'K.Sum name (ADTRep t) => BuildableADT t name
112+instance GGBuildable 'K.Sum name (ADTRep t) => BuildableADT t name
113+
114+
115+type BuildADT :: K.Rel8able -> Symbol -> Type
116+type BuildADT t name = GGBuild 'K.Sum name (ADTRep t) (ADT t Expr)
117+
118+
119+buildADT :: forall t name. BuildableADT t name => BuildADT t name
120+buildADT =
121+ ggbuild @'K.Sum @name @(ADTRep t) @(ADT t Expr) ADT
122+
123+
124+type ConstructableADT :: K.Rel8able -> Constraint
125+class GGConstructable 'K.Sum (ADTRep t) => ConstructableADT t
126+instance GGConstructable 'K.Sum (ADTRep t) => ConstructableADT t
127+
128+
129+type ConstructADT :: K.Rel8able -> Type
130+type ConstructADT t = forall r. GGConstruct 'K.Sum (ADTRep t) r
131+
132+
133+constructADT :: forall t. ConstructableADT t => ConstructADT t -> ADT t Expr
134+constructADT f =
135+ ggconstruct @'K.Sum @(ADTRep t) @(ADT t Expr) ADT
136+ (f @(ADT t Expr))
137+
138+
139+type DeconstructADT :: K.Rel8able -> Type -> Type
140+type DeconstructADT t r = GGDeconstruct 'K.Sum (ADTRep t) (ADT t Expr) r
141+
142+
143+deconstructADT :: forall t r. (ConstructableADT t, Table Expr r)
144+ => DeconstructADT t r
145+deconstructADT =
146+ ggdeconstruct @'K.Sum @(ADTRep t) @(ADT t Expr) @r (\(ADT a) -> a)
147+
148+
149+type NameADT :: K.Rel8able -> Type
150+type NameADT t = GGName 'K.Sum (ADTRep t) (ADT t Name)
151+
152+
153+nameADT :: forall t. ConstructableADT t => NameADT t
154+nameADT = ggname @'K.Sum @(ADTRep t) @(ADT t Name) ADT
155+
156+
157+type AggregateADT :: K.Rel8able -> Type
158+type AggregateADT t = forall r. GGAggregate 'K.Sum (ADTRep t) r
159+
160+
161+aggregateADT :: forall t. ConstructableADT t
162+ => AggregateADT t -> ADT t Expr -> ADT t Aggregate
163+aggregateADT f =
164+ ggaggregate @'K.Sum @(ADTRep t) @(ADT t Expr) @(ADT t Aggregate) ADT (\(ADT a) -> a)
165+ (f @(ADT t Aggregate))
166+
167+
168+data ADTRep :: K.Rel8able -> K.Context -> Exp (Type -> Type)
169+type instance Eval (ADTRep t context) = GRep t context
170+
171+
172+type GColumnsADT :: K.Rel8able -> K.HTable
173+type GColumnsADT t = G.GColumnsADT TColumns (GRep t Expr)
src/Rel8/Table/Aggregate.hs+37−36
@@ -1,13 +1,13 @@
1{-# language FlexibleContexts #-}
1{-# language FlexibleContexts #-}
2+{-# language NamedFieldPuns #-}
2{-# language ScopedTypeVariables #-}
3{-# language ScopedTypeVariables #-}
3{-# language TypeApplications #-}
4{-# language TypeApplications #-}
4{-# language TypeFamilies #-}
5{-# language TypeFamilies #-}
5{-# language ViewPatterns #-}
6{-# language ViewPatterns #-}
6
7
7module Rel8.Table.Aggregate
8module Rel8.Table.Aggregate
8− ( groupBy
9+ ( groupBy, hgroupBy
9 , listAgg, nonEmptyAgg
10 , listAgg, nonEmptyAgg
10− , listAggWithOrder, nonEmptyAggWithOrder
11 )
11 )
12where
12where
13
13
@@ -16,32 +16,49 @@ import Data.Functor.Identity ( Identity( Identity ) )
16import Prelude
16import Prelude
17
17
18-- rel8
18-- rel8
19−import Rel8.Aggregate ( Aggregate, Col(..) )
19+import Rel8.Aggregate ( Aggregate, Aggregates )
20−import Rel8.Expr ( Expr, Col(..) )
20+import Rel8.Expr ( Expr )
21import Rel8.Expr.Aggregate
21import Rel8.Expr.Aggregate
22 ( groupByExpr
22 ( groupByExpr
23− , listAggExpr
23+ , slistAggExpr
24− , listAggExprWithOrder
24+ , snonEmptyAggExpr
25− , nonEmptyAggExpr
26− , nonEmptyAggExprWithOrder
27 )
25 )
28−import Rel8.Order ( Order )
29import Rel8.Schema.Dict ( Dict( Dict ) )
26import Rel8.Schema.Dict ( Dict( Dict ) )
30−import Rel8.Schema.HTable ( htabulate, hfield )
27+import Rel8.Schema.HTable ( HTable, hfield, htabulate )
31import Rel8.Schema.HTable.Vectorize ( hvectorize )
28import Rel8.Schema.HTable.Vectorize ( hvectorize )
32−import Rel8.Table ( Table, toColumns, fromColumns )
29+import Rel8.Schema.Null ( Sql )
30+import Rel8.Schema.Spec ( Spec( Spec, info ) )
31+import Rel8.Table ( toColumns, fromColumns )
33import Rel8.Table.Eq ( EqTable, eqTable )
32import Rel8.Table.Eq ( EqTable, eqTable )
34import Rel8.Table.List ( ListTable )
33import Rel8.Table.List ( ListTable )
35import Rel8.Table.NonEmpty ( NonEmptyTable )
34import Rel8.Table.NonEmpty ( NonEmptyTable )
35+import Rel8.Type.Eq ( DBEq )
36
36
37
37
38-- | Group equal tables together. This works by aggregating each column in the
38-- | Group equal tables together. This works by aggregating each column in the
39-- given table with 'groupByExpr'.
39-- given table with 'groupByExpr'.
40−groupBy :: forall exprs. EqTable exprs => exprs -> Aggregate exprs
40+--
41−groupBy (toColumns -> exprs) = fromColumns $ htabulate $ \field ->
41+-- For example, if we have a table of items, we could group the items by the
42− case hfield (eqTable @exprs) field of
42+-- order they belong to:
43+--
44+-- @
45+-- itemsByOrder :: Query (OrderId Expr, ListTable Expr (Item Expr))
46+-- itemsByOrder = aggregate $ do
47+-- item <- each itemSchema
48+-- let orderId = groupBy (itemOrderId item)
49+-- let orderItems = listAgg item
50+-- pure (orderId, orderItems)
51+-- @
52+groupBy :: forall exprs aggregates. (EqTable exprs, Aggregates aggregates exprs)
53+ => exprs -> aggregates
54+groupBy = fromColumns . hgroupBy (eqTable @exprs) . toColumns
55+
56+
57+hgroupBy :: HTable t => t (Dict (Sql DBEq)) -> t Expr -> t Aggregate
58+hgroupBy eqs exprs = htabulate $ \field ->
59+ case hfield eqs field of
43 Dict -> case hfield exprs field of
60 Dict -> case hfield exprs field of
44− DB expr -> Aggregation $ groupByExpr expr
61+ expr -> groupByExpr expr
45
62
46
63
47-- | Aggregate rows into a single row containing an array of all aggregated
64-- | Aggregate rows into a single row containing an array of all aggregated
@@ -54,38 +71,22 @@ groupBy (toColumns -> exprs) = fromColumns $ htabulate $ \field ->
54-- items:
71-- items:
55--
72--
56-- @
73-- @
57−-- ordersWithItems :: Query (Order Expr, ListTable (Item Expr))
74+-- ordersWithItems :: Query (Order Expr, ListTable Expr (Item Expr))
58-- ordersWithItems = do
75-- ordersWithItems = do
59-- order <- each orderSchema
76-- order <- each orderSchema
60-- items <- aggregate $ listAgg <$> itemsFromOrder order
77-- items <- aggregate $ listAgg <$> itemsFromOrder order
61-- return (order, items)
78-- return (order, items)
62-- @
79-- @
63−listAgg :: Table Expr a => a -> Aggregate (ListTable a)
80+listAgg :: Aggregates aggregates exprs => exprs -> ListTable Aggregate aggregates
64listAgg (toColumns -> exprs) = fromColumns $
81listAgg (toColumns -> exprs) = fromColumns $
65 hvectorize
82 hvectorize
66− (\_ (Identity (DB a)) -> Aggregation $ listAggExpr a)
83+ (\Spec {info} (Identity a) -> slistAggExpr info a)
67 (pure exprs)
84 (pure exprs)
68
85
69
86
70-- | Like 'listAgg', but the result is guaranteed to be a non-empty list.
87-- | Like 'listAgg', but the result is guaranteed to be a non-empty list.
71−nonEmptyAgg :: Table Expr a => a -> Aggregate (NonEmptyTable a)
88+nonEmptyAgg :: Aggregates aggregates exprs => exprs -> NonEmptyTable Aggregate aggregates
72nonEmptyAgg (toColumns -> exprs) = fromColumns $
89nonEmptyAgg (toColumns -> exprs) = fromColumns $
73 hvectorize
90 hvectorize
74− (\_ (Identity (DB a)) -> Aggregation $ nonEmptyAggExpr a)
91+ (\Spec {info} (Identity a) -> snonEmptyAggExpr info a)
75− (pure exprs)
76−
77−
78−listAggWithOrder :: Table Expr a
79− => Order o -> o -> a -> Aggregate (ListTable a)
80−listAggWithOrder order o (toColumns -> exprs) = fromColumns $
81− hvectorize
82− (\_ (Identity (DB x)) -> Aggregation $ listAggExprWithOrder order o x)
83− (pure exprs)
84−
85−
86−nonEmptyAggWithOrder :: Table Expr a
87− => Order o -> o -> a -> Aggregate (NonEmptyTable a)
88−nonEmptyAggWithOrder order o (toColumns -> exprs) = fromColumns $
89− hvectorize
90− (\_ (Identity (DB x)) -> Aggregation $ nonEmptyAggExprWithOrder order o x)
91 (pure exprs)
92 (pure exprs)
src/Rel8/Table/Bool.hs+12−6
@@ -5,6 +5,7 @@
5module Rel8.Table.Bool
5module Rel8.Table.Bool
6 ( bool
6 ( bool
7 , case_
7 , case_
8+ , nullable
8 )
9 )
9where
10where
10
11
@@ -12,8 +13,9 @@ where
12import Prelude
13import Prelude
13
14
14-- rel8
15-- rel8
15−import Rel8.Expr ( Expr, Col(..) )
16+import Rel8.Expr ( Expr )
16import Rel8.Expr.Bool ( boolExpr, caseExpr )
17import Rel8.Expr.Bool ( boolExpr, caseExpr )
18+import Rel8.Expr.Null ( isNull, unsafeUnnullify )
17import Rel8.Schema.HTable ( htabulate, hfield )
19import Rel8.Schema.HTable ( htabulate, hfield )
18import Rel8.Table ( Table, fromColumns, toColumns )
20import Rel8.Table ( Table, fromColumns, toColumns )
19
21
@@ -26,8 +28,7 @@ bool :: Table Expr a => a -> a -> Expr Bool -> a
26bool (toColumns -> false) (toColumns -> true) condition =
28bool (toColumns -> false) (toColumns -> true) condition =
27 fromColumns $ htabulate $ \field ->
29 fromColumns $ htabulate $ \field ->
28 case (hfield false field, hfield true field) of
30 case (hfield false field, hfield true field) of
29− (DB falseExpr, DB trueExpr) ->
31+ (falseExpr, trueExpr) -> boolExpr falseExpr trueExpr condition
30− DB (boolExpr falseExpr trueExpr condition)
31{-# INLINABLE bool #-}
32{-# INLINABLE bool #-}
32
33
33
34
@@ -37,6 +38,11 @@ bool (toColumns -> false) (toColumns -> true) condition =
37case_ :: Table Expr a => [(Expr Bool, a)] -> a -> a
38case_ :: Table Expr a => [(Expr Bool, a)] -> a -> a
38case_ (map (fmap toColumns) -> branches) (toColumns -> fallback) =
39case_ (map (fmap toColumns) -> branches) (toColumns -> fallback) =
39 fromColumns $ htabulate $ \field -> case hfield fallback field of
40 fromColumns $ htabulate $ \field -> case hfield fallback field of
40− DB fallbackExpr ->
41+ fallbackExpr ->
41− case map (fmap (unDB . (`hfield` field))) branches of
42+ case map (fmap (`hfield` field)) branches of
42− branchExprs -> DB (caseExpr branchExprs fallbackExpr)
43+ branchExprs -> caseExpr branchExprs fallbackExpr
44+
45+
46+-- | Like 'maybe', but to eliminate @null@.
47+nullable :: Table Expr b => b -> (Expr a -> b) -> Expr (Maybe a) -> b
48+nullable b f ma = bool (f (unsafeUnnullify ma)) b (isNull ma)
src/Rel8/Table/Cols.hsnew file+50
@@ -0,0 +1,50 @@
1+{-# language DataKinds #-}
2+{-# language FlexibleInstances #-}
3+{-# language MultiParamTypeClasses #-}
4+{-# language StandaloneKindSignatures #-}
5+{-# language TypeFamilies #-}
6+{-# language UndecidableInstances #-}
7+
8+module Rel8.Table.Cols
9+ ( Cols( Cols )
10+ , fromCols
11+ , toCols
12+ )
13+where
14+
15+-- base
16+import Data.Kind ( Type )
17+import Prelude
18+
19+-- rel8
20+import qualified Rel8.Schema.Kind as K
21+import Rel8.Schema.HTable ( HTable )
22+import Rel8.Schema.Result ( Result )
23+import Rel8.Table ( Table(..) )
24+
25+
26+type Cols :: K.Context -> K.HTable -> Type
27+newtype Cols context columns = Cols (columns context)
28+
29+
30+instance (HTable columns, context ~ context') =>
31+ Table context' (Cols context columns)
32+ where
33+ type Columns (Cols context columns) = columns
34+ type Context (Cols context columns) = context
35+ type FromExprs (Cols context columns) = Cols Result columns
36+ type Transpose to (Cols context columns) = Cols to columns
37+
38+ toColumns (Cols a) = a
39+ fromColumns = Cols
40+
41+ toResult (Cols a) = a
42+ fromResult = Cols
43+
44+
45+fromCols :: Table context a => Cols context (Columns a) -> a
46+fromCols (Cols a) = fromColumns a
47+
48+
49+toCols :: Table context a => a -> Cols context (Columns a)
50+toCols = Cols . toColumns
src/Rel8/Table/Either.hs+151−129
@@ -3,6 +3,7 @@
3{-# language DerivingStrategies #-}
3{-# language DerivingStrategies #-}
4{-# language FlexibleContexts #-}
4{-# language FlexibleContexts #-}
5{-# language FlexibleInstances #-}
5{-# language FlexibleInstances #-}
6+{-# language LambdaCase #-}
6{-# language MultiParamTypeClasses #-}
7{-# language MultiParamTypeClasses #-}
7{-# language NamedFieldPuns #-}
8{-# language NamedFieldPuns #-}
8{-# language ScopedTypeVariables #-}
9{-# language ScopedTypeVariables #-}
@@ -11,211 +12,232 @@
11{-# language TypeFamilies #-}
12{-# language TypeFamilies #-}
12{-# language UndecidableInstances #-}
13{-# language UndecidableInstances #-}
13
14
15+{-# options_ghc -fno-warn-orphans #-}
16+
14module Rel8.Table.Either
17module Rel8.Table.Either
15 ( EitherTable(..)
18 ( EitherTable(..)
16 , eitherTable, leftTable, rightTable
19 , eitherTable, leftTable, rightTable
17 , isLeftTable, isRightTable
20 , isLeftTable, isRightTable
18− , aggregateEitherTable, nameEitherTable
21+ , aggregateEitherTable
22+ , nameEitherTable
19 )
23 )
20where
24where
21
25
22-- base
26-- base
23−import Control.Applicative ( liftA2 )
24import Data.Bifunctor ( Bifunctor, bimap )
27import Data.Bifunctor ( Bifunctor, bimap )
25−import Data.Functor.Identity ( runIdentity )
28+import Data.Functor.Identity ( Identity( Identity ) )
26import Data.Kind ( Type )
29import Data.Kind ( Type )
27import Prelude hiding ( undefined )
30import Prelude hiding ( undefined )
28
31
32+-- comonad
33+import Control.Comonad ( extract )
34+
29-- rel8
35-- rel8
30−import Rel8.Aggregate ( Aggregate, unsafeMakeAggregate )
36+import Rel8.Aggregate ( Aggregate )
31import Rel8.Expr ( Expr )
37import Rel8.Expr ( Expr )
32−import Rel8.Expr.Opaleye ( fromPrimExpr, toPrimExpr )
38+import Rel8.Expr.Aggregate ( groupByExpr )
33import Rel8.Expr.Serialize ( litExpr )
39import Rel8.Expr.Serialize ( litExpr )
34−import Rel8.Schema.Context.Label
40+import Rel8.Kind.Context ( Reifiable )
35− ( Labelable
41+import Rel8.Schema.Context.Nullify ( Nullifiable )
36− , HLabelable, hlabeler, hunlabeler
42+import Rel8.Schema.Dict ( Dict( Dict ) )
37− )
38−import Rel8.Schema.Context.Nullify
39− ( Nullifiable, ConstrainTag
40− , HNullifiable, HConstrainTag
41− , hencodeTag, hdecodeTag
42− , hnullifier, hunnullifier
43− )
44−import Rel8.Schema.HTable ( HTable )
45import Rel8.Schema.HTable.Either ( HEitherTable(..) )
43import Rel8.Schema.HTable.Either ( HEitherTable(..) )
46import Rel8.Schema.HTable.Identity ( HIdentity(..) )
44import Rel8.Schema.HTable.Identity ( HIdentity(..) )
47import Rel8.Schema.HTable.Label ( hlabel, hunlabel )
45import Rel8.Schema.HTable.Label ( hlabel, hunlabel )
48−import Rel8.Schema.HTable.Nullify ( hnullify, hunnullify )
46+import qualified Rel8.Schema.Kind as K
49import Rel8.Schema.Name ( Name )
47import Rel8.Schema.Name ( Name )
50import Rel8.Table
48import Rel8.Table
51 ( Table, Columns, Context, fromColumns, toColumns
49 ( Table, Columns, Context, fromColumns, toColumns
52− , reify, unreify
50+ , FromExprs, fromResult, toResult
51+ , Transpose
53 )
52 )
54import Rel8.Table.Bool ( bool )
53import Rel8.Table.Bool ( bool )
55import Rel8.Table.Eq ( EqTable, eqTable )
54import Rel8.Table.Eq ( EqTable, eqTable )
55+import Rel8.Table.Nullify ( Nullify, aggregateNullify, guard )
56import Rel8.Table.Ord ( OrdTable, ordTable )
56import Rel8.Table.Ord ( OrdTable, ordTable )
57−import Rel8.Table.Recontextualize ( Recontextualize )
57+import Rel8.Table.Projection ( Biprojectable, Projectable, biproject, project )
58−import Rel8.Table.Tag ( Tag(..), fromExpr, fromName )
58+import Rel8.Table.Serialize ( ToExprs )
59import Rel8.Table.Undefined ( undefined )
59import Rel8.Table.Undefined ( undefined )
60import Rel8.Type.Tag ( EitherTag( IsLeft, IsRight ), isLeft, isRight )
60import Rel8.Type.Tag ( EitherTag( IsLeft, IsRight ), isLeft, isRight )
61
61
62-- semigroupoids
62-- semigroupoids
63−import Data.Functor.Apply ( Apply, (<.>), liftF3 )
63+import Data.Functor.Apply ( Apply, (<.>) )
64import Data.Functor.Bind ( Bind, (>>-) )
64import Data.Functor.Bind ( Bind, (>>-) )
65
65
66
66
67−type EitherTable :: Type -> Type -> Type
67+-- | An @EitherTable a b@ is a Rel8 table that contains either the table @a@ or
68−data EitherTable a b = EitherTable
68+-- the table @b@. You can construct an @EitherTable@ using 'leftTable' and
69− { tag :: Tag "isRight" EitherTag
69+-- 'rightTable', and eliminate/pattern match using 'eitherTable'.
70− , left :: a
70+--
71− , right :: b
71+-- An @EitherTable@ is operationally the same as Haskell's 'Either' type, but
72+-- adapted to work with Rel8.
73+type EitherTable :: K.Context -> Type -> Type -> Type
74+data EitherTable context a b = EitherTable
75+ { tag :: context EitherTag
76+ , left :: Nullify context a
77+ , right :: Nullify context b
72 }
78 }
73 deriving stock Functor
79 deriving stock Functor
74
80
75
81
76−instance Bifunctor EitherTable where
82+instance Biprojectable (EitherTable context) where
77− bimap f g (EitherTable tag a b) = EitherTable tag (f a) (g b)
83+ biproject f g (EitherTable tag a b) =
84+ EitherTable tag (project f a) (project g b)
85+
86+
87+instance Nullifiable context => Bifunctor (EitherTable context) where
88+ bimap f g (EitherTable tag a b) = EitherTable tag (fmap f a) (fmap g b)
78
89
79
90
80−instance Table Expr a => Apply (EitherTable a) where
91+instance Projectable (EitherTable context a) where
92+ project f (EitherTable tag a b) = EitherTable tag a (project f b)
93+
94+
95+instance (context ~ Expr, Table Expr a) => Apply (EitherTable context a) where
81 EitherTable tag l1 f <.> EitherTable tag' l2 a =
96 EitherTable tag l1 f <.> EitherTable tag' l2 a =
82− EitherTable (tag <> tag') (bool l1 l2 (isLeft (expr tag))) (f a)
97+ EitherTable (tag <> tag') (bool l1 l2 (isLeft tag)) (f <.> a)
83
98
84
99
85−instance Table Expr a => Applicative (EitherTable a) where
100+instance (context ~ Expr, Table Expr a) => Applicative (EitherTable context a) where
86 pure = rightTable
101 pure = rightTable
87 (<*>) = (<.>)
102 (<*>) = (<.>)
88
103
89
104
90−instance Table Expr a => Bind (EitherTable a) where
105+instance (context ~ Expr, Table Expr a) => Bind (EitherTable context a) where
91− EitherTable tag l1 a >>- f = case f a of
106+ EitherTable tag l1 a >>- f = case f (extract a) of
92 EitherTable tag' l2 b ->
107 EitherTable tag' l2 b ->
93− EitherTable (tag <> tag') (bool l1 l2 (isRight (expr tag))) b
108+ EitherTable (tag <> tag') (bool l1 l2 (isRight tag)) b
94
109
95
110
96−instance Table Expr a => Monad (EitherTable a) where
111+instance (context ~ Expr, Table Expr a) => Monad (EitherTable context a) where
97 (>>=) = (>>-)
112 (>>=) = (>>-)
98
113
99
114
100−instance (Table Expr a, Table Expr b) => Semigroup (EitherTable a b) where
115+instance (context ~ Expr, Table Expr a, Table Expr b) =>
116+ Semigroup (EitherTable context a b)
117+ where
101 a <> b = bool a b (isRightTable a)
118 a <> b = bool a b (isRightTable a)
102
119
103
120
104instance
121instance
105 ( Table context a, Table context b
122 ( Table context a, Table context b
106− , Labelable context, Nullifiable context, ConstrainTag context EitherTag
123+ , Reifiable context, context ~ context'
107− ) =>
124+ )
108− Table context (EitherTable a b)
125+ => Table context' (EitherTable context a b)
109 where
126 where
110− type Columns (EitherTable a b) = HEitherTable (Columns a) (Columns b)
127+ type Columns (EitherTable context a b) = HEitherTable (Columns a) (Columns b)
111− type Context (EitherTable a b) = Context a
128+ type Context (EitherTable context a b) = Context a
112−
129+ type FromExprs (EitherTable context a b) = Either (FromExprs a) (FromExprs b)
113− toColumns = toColumns2 toColumns toColumns
130+ type Transpose to (EitherTable context a b) =
114− fromColumns = fromColumns2 fromColumns fromColumns
131+ EitherTable to (Transpose to a) (Transpose to b)
115− reify = liftA2 bimap reify reify
132+
116− unreify = liftA2 bimap unreify unreify
133+ toColumns EitherTable {tag, left, right} = HEitherTable
117−
134+ { htag = hlabel $ HIdentity tag
118−
135+ , hleft = hlabel $ guard tag (== IsLeft) isLeft $ toColumns left
119−instance
136+ , hright = hlabel $ guard tag (== IsRight) isRight $ toColumns right
120− ( Nullifiable from, Labelable from, ConstrainTag from EitherTag
137+ }
121− , Nullifiable to, Labelable to, ConstrainTag to EitherTag
138+
122− , Recontextualize from to a1 b1
139+ fromColumns HEitherTable {htag, hleft, hright} = EitherTable
123− , Recontextualize from to a2 b2
140+ { tag = unHIdentity $ hunlabel htag
124− ) =>
141+ , left = fromColumns $ hunlabel hleft
125− Recontextualize from to (EitherTable a1 a2) (EitherTable b1 b2)
142+ , right = fromColumns $ hunlabel hright
143+ }
144+
145+ toResult = \case
146+ Left table -> HEitherTable
147+ { htag = hlabel (HIdentity (Identity IsLeft))
148+ , hleft = hlabel (toResult @_ @(Nullify context a) (Just table))
149+ , hright = hlabel (toResult @_ @(Nullify context b) Nothing)
150+ }
151+ Right table -> HEitherTable
152+ { htag = hlabel (HIdentity (Identity IsRight))
153+ , hleft = hlabel (toResult @_ @(Nullify context a) Nothing)
154+ , hright = hlabel (toResult @_ @(Nullify context b) (Just table))
155+ }
156+
157+ fromResult HEitherTable {htag, hleft, hright} = case hunlabel htag of
158+ HIdentity (Identity tag) -> case tag of
159+ IsLeft -> maybe err Left $ fromResult @_ @(Nullify context a) (hunlabel hleft)
160+ IsRight -> maybe err Right $ fromResult @_ @(Nullify context b) (hunlabel hright)
161+ where
162+ err = error "Either.fromColumns: mismatch between tag and data"
163+
164+
165+instance (EqTable a, EqTable b, context ~ Expr) =>
166+ EqTable (EitherTable context a b)
167+ where
168+ eqTable = HEitherTable
169+ { htag = hlabel (HIdentity Dict)
170+ , hleft = hlabel (eqTable @(Nullify context a))
171+ , hright = hlabel (eqTable @(Nullify context b))
172+ }
126
173
127
174
128−instance (EqTable a, EqTable b) => EqTable (EitherTable a b) where
175+instance (OrdTable a, OrdTable b, context ~ Expr) =>
129− eqTable = toColumns2 id id (rightTableWith (eqTable @a) (eqTable @b))
176+ OrdTable (EitherTable context a b)
177+ where
178+ ordTable = HEitherTable
179+ { htag = hlabel (HIdentity Dict)
180+ , hleft = hlabel (ordTable @(Nullify context a))
181+ , hright = hlabel (ordTable @(Nullify context b))
182+ }
130
183
131
184
132−instance (OrdTable a, OrdTable b) => OrdTable (EitherTable a b) where
185+instance (ToExprs exprs1 a, ToExprs exprs2 b, x ~ EitherTable Expr exprs1 exprs2) =>
133− ordTable = toColumns2 id id (rightTableWith (ordTable @a) (ordTable @b))
186+ ToExprs x (Either a b)
134
187
135
188
136−isLeftTable :: EitherTable a b -> Expr Bool
189+-- | Test if an 'EitherTable' is a 'leftTable'.
137−isLeftTable = isLeft . expr . tag
190+isLeftTable :: EitherTable Expr a b -> Expr Bool
191+isLeftTable EitherTable {tag} = isLeft tag
138
192
139
193
140−isRightTable :: EitherTable a b -> Expr Bool
194+-- | Test if an 'EitherTable' is a 'rightTable'.
141−isRightTable = isRight . expr . tag
195+isRightTable :: EitherTable Expr a b -> Expr Bool
196+isRightTable EitherTable {tag} = isRight tag
142
197
143
198
199+-- | Pattern match/eliminate an 'EitherTable', by providing mappings from a
200+-- 'leftTable' and 'rightTable'.
144eitherTable :: Table Expr c
201eitherTable :: Table Expr c
145− => (a -> c) -> (b -> c) -> EitherTable a b -> c
202+ => (a -> c) -> (b -> c) -> EitherTable Expr a b -> c
146eitherTable f g EitherTable {tag, left, right} =
203eitherTable f g EitherTable {tag, left, right} =
147− bool (f left) (g right) (isRight (expr tag))
204+ bool (f (extract left)) (g (extract right)) (isRight tag)
148
205
149
206
150−leftTable :: Table Expr b => a -> EitherTable a b
207+-- | Construct a left 'EitherTable'. Like 'Left'.
151−leftTable a = EitherTable (fromExpr (litExpr IsLeft)) a undefined
208+leftTable :: Table Expr b => a -> EitherTable Expr a b
209+leftTable a = EitherTable (litExpr IsLeft) (pure a) undefined
152
210
153
211
154−rightTable :: Table Expr a => b -> EitherTable a b
212+-- | Construct a right 'EitherTable'. Like 'Right'.
155−rightTable = rightTableWith undefined
213+rightTable :: Table Expr a => b -> EitherTable Expr a b
156−
214+rightTable = EitherTable (litExpr IsRight) undefined . pure
157−
158−rightTableWith :: a -> b -> EitherTable a b
159−rightTableWith = EitherTable (fromExpr (litExpr IsRight))
160
215
161
216
217+-- | Lift a pair of aggregating functions to operate on an 'EitherTable'.
218+-- @leftTable@s and @rightTable@s are grouped separately.
162aggregateEitherTable :: ()
219aggregateEitherTable :: ()
163− => (a -> Aggregate c)
220+ => (exprs -> aggregates)
164− -> (b -> Aggregate d)
221+ -> (exprs' -> aggregates')
165− -> EitherTable a b
222+ -> EitherTable Expr exprs exprs'
166− -> Aggregate (EitherTable c d)
223+ -> EitherTable Aggregate aggregates aggregates'
167−aggregateEitherTable f g EitherTable {tag, left, right} =
224+aggregateEitherTable f g (EitherTable tag a b) = EitherTable
168− liftF3 EitherTable (tag <$ aggregate) (f left) (g right)
225+ { tag = groupByExpr tag
169− where
226+ , left = aggregateNullify f a
170− Tag {aggregator, expr} = tag
227+ , right = aggregateNullify g b
171− aggregate = unsafeMakeAggregate toPrimExpr fromPrimExpr aggregator expr
172−
173−
174−nameEitherTable :: Name EitherTag -> a -> b -> EitherTable a b
175−nameEitherTable = EitherTable . fromName
176−
177−
178−toColumns2 ::
179− ( HTable t
180− , HTable u
181− , HConstrainTag context EitherTag
182− , HLabelable context
183− , HNullifiable context
184− )
185− => (a -> t context)
186− -> (b -> u context)
187− -> EitherTable a b
188− -> HEitherTable t u context
189−toColumns2 f g EitherTable {tag, left, right} = HEitherTable
190− { htag
191− , hleft = hlabel hlabeler $ hnullify (hnullifier tag isLeft) $ f left
192− , hright = hlabel hlabeler $ hnullify (hnullifier tag isRight) $ g right
193 }
228 }
194− where
195− htag = HIdentity (hencodeTag tag)
196
229
197
230
198−fromColumns2 ::
231+-- | Construct a 'EitherTable' in the 'Name' context. This can be useful if you
199− ( HTable t
232+-- have a 'EitherTable' that you are storing in a table and need to construct a
200− , HTable u
233+-- 'TableSchema'.
201− , HConstrainTag context EitherTag
234+nameEitherTable
202− , HLabelable context
235+ :: Name EitherTag
203− , HNullifiable context
236+ -- ^ The name of the column to track whether a row is a 'leftTable' or
204− )
237+ -- 'rightTable'.
205− => (t context -> a)
238+ -> a
206− -> (u context -> b)
239+ -- ^ Names of the columns in the @a@ table.
207− -> HEitherTable t u context
240+ -> b
208− -> EitherTable a b
241+ -- ^ Names of the columns in the @b@ table.
209−fromColumns2 f g HEitherTable {htag, hleft, hright} = EitherTable
242+ -> EitherTable Name a b
210− { tag
243+nameEitherTable tag left right = EitherTable tag (pure left) (pure right)
211− , left = f $ runIdentity $
212− hunnullify (\a -> pure . hunnullifier a) $
213− hunlabel hunlabeler
214− hleft
215− , right = g $ runIdentity $
216− hunnullify (\a -> pure . hunnullifier a) $
217− hunlabel hunlabeler
218− hright
219− }
220− where
221− tag = hdecodeTag $ unHIdentity htag
src/Rel8/Table/Eq.hs+12−39
@@ -11,7 +11,6 @@
11{-# language TypeFamilies #-}
11{-# language TypeFamilies #-}
12{-# language TypeOperators #-}
12{-# language TypeOperators #-}
13{-# language UndecidableInstances #-}
13{-# language UndecidableInstances #-}
14−{-# language UndecidableSuperClasses #-}
15{-# language ViewPatterns #-}
14{-# language ViewPatterns #-}
16
15
17module Rel8.Table.Eq
16module Rel8.Table.Eq
@@ -24,26 +23,20 @@ import Data.Foldable ( foldl' )
24import Data.Functor.Const ( Const( Const ), getConst )
23import Data.Functor.Const ( Const( Const ), getConst )
25import Data.Kind ( Constraint, Type )
24import Data.Kind ( Constraint, Type )
26import Data.List.NonEmpty ( NonEmpty( (:|) ) )
25import Data.List.NonEmpty ( NonEmpty( (:|) ) )
27−import Data.Proxy ( Proxy )
28import GHC.Generics ( Rep )
26import GHC.Generics ( Rep )
29import Prelude
27import Prelude
30
28
31-- rel8
29-- rel8
32−import Rel8.Expr ( Expr, Col(..) )
30+import Rel8.Expr ( Expr )
33import Rel8.Expr.Bool ( (||.), (&&.) )
31import Rel8.Expr.Bool ( (||.), (&&.) )
34import Rel8.Expr.Eq ( (==.), (/=.) )
32import Rel8.Expr.Eq ( (==.), (/=.) )
35import Rel8.FCF ( Eval, Exp )
33import Rel8.FCF ( Eval, Exp )
36import Rel8.Generic.Record ( Record )
34import Rel8.Generic.Record ( Record )
37−import Rel8.Generic.Table ( GTable, GColumns, gtable )
35+import Rel8.Generic.Table.Record ( GTable, GColumns, gtable )
38import Rel8.Schema.Dict ( Dict( Dict ) )
36import Rel8.Schema.Dict ( Dict( Dict ) )
39−import Rel8.Schema.HTable
37+import Rel8.Schema.HTable ( htabulateA, hfield )
40− ( HTable, HConstrainTable
38+import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
41− , htabulateA, hfield, hdicts
42− )
43−import Rel8.Schema.HTable.Type ( HType(..) )
44−import Rel8.Schema.Kind ( Context )
45import Rel8.Schema.Null ( Sql )
39import Rel8.Schema.Null ( Sql )
46−import Rel8.Schema.Spec.ConstrainDBType ( ConstrainDBType )
47import Rel8.Table ( Table, Columns, toColumns, TColumns )
40import Rel8.Table ( Table, Columns, toColumns, TColumns )
48import Rel8.Type.Eq ( DBEq )
41import Rel8.Type.Eq ( DBEq )
49
42
@@ -53,44 +46,24 @@ import Rel8.Type.Eq ( DBEq )
53-- means "all columns in a 'Table' have an instance of 'DBEq'".
46-- means "all columns in a 'Table' have an instance of 'DBEq'".
54type EqTable :: Type -> Constraint
47type EqTable :: Type -> Constraint
55class Table Expr a => EqTable a where
48class Table Expr a => EqTable a where
56− eqTable :: Columns a (Dict (ConstrainDBType DBEq))
49+ eqTable :: Columns a (Dict (Sql DBEq))
57
50
58 default eqTable ::
51 default eqTable ::
59− ( GTable TEqTable TColumns (Dict (ConstrainDBType DBEq)) (Rep (Record a))
52+ ( GTable TEqTable TColumns (Rep (Record a))
60 , Columns a ~ GColumns TColumns (Rep (Record a))
53 , Columns a ~ GColumns TColumns (Rep (Record a))
61 )
54 )
62− => Columns a (Dict (ConstrainDBType DBEq))
55+ => Columns a (Dict (Sql DBEq))
63− eqTable = gtable @TEqTable @TColumns @_ @(Rep (Record a)) table
56+ eqTable = gtable @TEqTable @TColumns @(Rep (Record a)) table
64 where
57 where
65− table (_ :: Proxy x) = eqTable @x
58+ table (_ :: proxy x) = eqTable @x
66
59
67
60
68data TEqTable :: Type -> Exp Constraint
61data TEqTable :: Type -> Exp Constraint
69type instance Eval (TEqTable a) = EqTable a
62type instance Eval (TEqTable a) = EqTable a
70
63
71
64
72−instance
73− ( Table Expr (t (Expr :: Context))
74− , f ~ Expr
75− , HConstrainTable (Columns (t Expr)) (ConstrainDBType DBEq)
76− )
77− => EqTable (t f)
78− where
79− eqTable = hdicts @(Columns (t f)) @(ConstrainDBType DBEq)
80−
81−
82−instance
83− ( HTable t
84− , f ~ Col Expr
85− , HConstrainTable t (ConstrainDBType DBEq)
86− )
87− => EqTable (t f)
88− where
89− eqTable = hdicts @(Columns (t f)) @(ConstrainDBType DBEq)
90−
91−
92instance Sql DBEq a => EqTable (Expr a) where
65instance Sql DBEq a => EqTable (Expr a) where
93− eqTable = HType Dict
66+ eqTable = HIdentity Dict
94
67
95
68
96instance (EqTable a, EqTable b) => EqTable (a, b)
69instance (EqTable a, EqTable b) => EqTable (a, b)
@@ -124,7 +97,7 @@ instance
124(toColumns -> as) ==: (toColumns -> bs) =
97(toColumns -> as) ==: (toColumns -> bs) =
125 foldl1' (&&.) $ getConst $ htabulateA $ \field ->
98 foldl1' (&&.) $ getConst $ htabulateA $ \field ->
126 case (hfield as field, hfield bs field) of
99 case (hfield as field, hfield bs field) of
127− (DB a, DB b) -> case hfield (eqTable @a) field of
100+ (a, b) -> case hfield (eqTable @a) field of
128 Dict -> Const (pure (a ==. b))
101 Dict -> Const (pure (a ==. b))
129infix 4 ==:
102infix 4 ==:
130
103
@@ -136,7 +109,7 @@ infix 4 ==:
136(toColumns -> as) /=: (toColumns -> bs) =
109(toColumns -> as) /=: (toColumns -> bs) =
137 foldl1' (||.) $ getConst $ htabulateA $ \field ->
110 foldl1' (||.) $ getConst $ htabulateA $ \field ->
138 case (hfield as field, hfield bs field) of
111 case (hfield as field, hfield bs field) of
139− (DB a, DB b) -> case hfield (eqTable @a) field of
112+ (a, b) -> case hfield (eqTable @a) field of
140 Dict -> Const (pure (a /=. b))
113 Dict -> Const (pure (a /=. b))
141infix 4 /=:
114infix 4 /=:
142
115
src/Rel8/Table/HKD.hsnew file+228
@@ -0,0 +1,228 @@
1+{-# language AllowAmbiguousTypes #-}
2+{-# language DataKinds #-}
3+{-# language FlexibleContexts #-}
4+{-# language FlexibleInstances #-}
5+{-# language MultiParamTypeClasses #-}
6+{-# language RankNTypes #-}
7+{-# language ScopedTypeVariables #-}
8+{-# language StandaloneKindSignatures #-}
9+{-# language TypeApplications #-}
10+{-# language TypeFamilies #-}
11+{-# language UndecidableInstances #-}
12+{-# language UndecidableSuperClasses #-}
13+
14+module Rel8.Table.HKD
15+ ( HKD( HKD )
16+ , HKDable
17+ , BuildableHKD
18+ , BuildHKD, buildHKD
19+ , ConstructableHKD
20+ , ConstructHKD, constructHKD
21+ , DeconstructHKD, deconstructHKD
22+ , NameHKD, nameHKD
23+ , AggregateHKD, aggregateHKD
24+ , HKDRep
25+ )
26+where
27+
28+-- base
29+import Data.Kind ( Constraint, Type )
30+import GHC.Generics ( Generic, Rep, from, to )
31+import GHC.TypeLits ( Symbol )
32+import Prelude
33+
34+-- rel8
35+import Rel8.Aggregate ( Aggregate )
36+import Rel8.Column ( TColumn )
37+import Rel8.Expr ( Expr )
38+import Rel8.FCF ( Eval, Exp )
39+import Rel8.Kind.Algebra ( KnownAlgebra )
40+import Rel8.Generic.Construction
41+ ( GGBuildable
42+ , GGBuild, ggbuild
43+ , GGConstructable
44+ , GGConstruct, ggconstruct
45+ , GGDeconstruct, ggdeconstruct
46+ , GGName, ggname
47+ , GGAggregate, ggaggregate
48+ )
49+import Rel8.Generic.Map ( GMap )
50+import Rel8.Generic.Record
51+ ( GRecord, GRecordable, grecord, gunrecord
52+ , Record( Record ), unrecord
53+ )
54+import Rel8.Generic.Rel8able
55+ ( Rel8able
56+ , GColumns, gfromColumns, gtoColumns
57+ , GFromExprs, gfromResult, gtoResult
58+ )
59+import Rel8.Generic.Table
60+ ( GGSerialize, GGColumns, GAlgebra, ggfromResult, ggtoResult
61+ )
62+import Rel8.Generic.Table.Record ( GTable, GContext )
63+import qualified Rel8.Generic.Table.Record as G
64+import qualified Rel8.Schema.Kind as K
65+import Rel8.Schema.HTable ( HTable )
66+import Rel8.Schema.Name ( Name )
67+import Rel8.Schema.Result ( Result )
68+import Rel8.Table
69+ ( Table, fromColumns, toColumns, fromResult, toResult
70+ , TTable, TColumns, TContext
71+ , TSerialize
72+ )
73+
74+
75+type GColumnsHKD :: Type -> K.HTable
76+type GColumnsHKD a =
77+ Eval (GGColumns (GAlgebra (Rep a)) TColumns (GRecord (GMap (TColumn Expr) (Rep a))))
78+
79+
80+type HKD :: Type -> K.Rel8able
81+newtype HKD a f = HKD (GColumnsHKD a f)
82+
83+
84+instance HKDable a => Rel8able (HKD a) where
85+ type GColumns (HKD a) = GColumnsHKD a
86+ type GFromExprs (HKD a) = a
87+
88+ gfromColumns _ = HKD
89+ gtoColumns _ (HKD a) = a
90+
91+ gfromResult =
92+ unrecord .
93+ to .
94+ ggfromResult
95+ @(GAlgebra (Rep a))
96+ @TSerialize
97+ @TColumns
98+ @(Eval (HKDRep a Expr))
99+ @(Eval (HKDRep a Result))
100+ (\(_ :: proxy x) -> fromResult @_ @x)
101+
102+ gtoResult =
103+ ggtoResult
104+ @(GAlgebra (Rep a))
105+ @TSerialize
106+ @TColumns
107+ @(Eval (HKDRep a Expr))
108+ @(Eval (HKDRep a Result))
109+ (\(_ :: proxy x) -> toResult @_ @x) .
110+ from .
111+ Record
112+
113+
114+instance
115+ ( GTable (TTable f) TColumns (GRecord (GMap (TColumn f) (Rep a)))
116+ , G.GColumns TColumns (GRecord (GMap (TColumn f) (Rep a))) ~ GColumnsHKD a
117+ , GContext TContext (GRecord (GMap (TColumn f) (Rep a))) ~ f
118+ , GRecordable (GMap (TColumn f) (Rep a))
119+ )
120+ => Generic (HKD a f)
121+ where
122+ type Rep (HKD a f) = GMap (TColumn f) (Rep a)
123+
124+ from =
125+ gunrecord @(GMap (TColumn f) (Rep a)) .
126+ G.gfromColumns
127+ @(TTable f)
128+ @TColumns
129+ fromColumns .
130+ (\(HKD a) -> a)
131+
132+ to =
133+ HKD .
134+ G.gtoColumns
135+ @(TTable f)
136+ @TColumns
137+ toColumns .
138+ grecord @(GMap (TColumn f) (Rep a))
139+
140+
141+type HKDable :: Type -> Constraint
142+class
143+ ( Generic (Record a)
144+ , HTable (GColumns (HKD a))
145+ , KnownAlgebra (GAlgebra (Rep a))
146+ , Eval (GGSerialize (GAlgebra (Rep a)) TSerialize TColumns (Eval (HKDRep a Expr)) (Eval (HKDRep a Result)))
147+ , GRecord (GMap (TColumn Result) (Rep a)) ~ Rep (Record a)
148+ )
149+ => HKDable a
150+instance
151+ ( Generic (Record a)
152+ , HTable (GColumns (HKD a))
153+ , KnownAlgebra (GAlgebra (Rep a))
154+ , Eval (GGSerialize (GAlgebra (Rep a)) TSerialize TColumns (Eval (HKDRep a Expr)) (Eval (HKDRep a Result)))
155+ , GRecord (GMap (TColumn Result) (Rep a)) ~ Rep (Record a)
156+ )
157+ => HKDable a
158+
159+
160+type Top_ :: Constraint
161+class Top_
162+instance Top_
163+
164+
165+data Top :: Type -> Exp Constraint
166+type instance Eval (Top _) = Top_
167+
168+
169+type BuildableHKD :: Type -> Symbol -> Constraint
170+class GGBuildable (GAlgebra (Rep a)) name (HKDRep a) => BuildableHKD a name
171+instance GGBuildable (GAlgebra (Rep a)) name (HKDRep a) => BuildableHKD a name
172+
173+
174+type BuildHKD :: Type -> Symbol -> Type
175+type BuildHKD a name = GGBuild (GAlgebra (Rep a)) name (HKDRep a) (HKD a Expr)
176+
177+
178+buildHKD :: forall a name. BuildableHKD a name => BuildHKD a name
179+buildHKD =
180+ ggbuild @(GAlgebra (Rep a)) @name @(HKDRep a) @(HKD a Expr) HKD
181+
182+
183+type ConstructableHKD :: Type -> Constraint
184+class GGConstructable (GAlgebra (Rep a)) (HKDRep a) => ConstructableHKD a
185+instance GGConstructable (GAlgebra (Rep a)) (HKDRep a) => ConstructableHKD a
186+
187+
188+type ConstructHKD :: Type -> Type
189+type ConstructHKD a = forall r. GGConstruct (GAlgebra (Rep a)) (HKDRep a) r
190+
191+
192+constructHKD :: forall a. ConstructableHKD a => ConstructHKD a -> HKD a Expr
193+constructHKD f =
194+ ggconstruct @(GAlgebra (Rep a)) @(HKDRep a) @(HKD a Expr) HKD
195+ (f @(HKD a Expr))
196+
197+
198+type DeconstructHKD :: Type -> Type -> Type
199+type DeconstructHKD a r = GGDeconstruct (GAlgebra (Rep a)) (HKDRep a) (HKD a Expr) r
200+
201+
202+deconstructHKD :: forall a r. (ConstructableHKD a, Table Expr r)
203+ => DeconstructHKD a r
204+deconstructHKD = ggdeconstruct @(GAlgebra (Rep a)) @(HKDRep a) @(HKD a Expr) @r (\(HKD a) -> a)
205+
206+
207+type NameHKD :: Type -> Type
208+type NameHKD a = GGName (GAlgebra (Rep a)) (HKDRep a) (HKD a Name)
209+
210+
211+nameHKD :: forall a. ConstructableHKD a => NameHKD a
212+nameHKD = ggname @(GAlgebra (Rep a)) @(HKDRep a) @(HKD a Name) HKD
213+
214+
215+type AggregateHKD :: Type -> Type
216+type AggregateHKD a = forall r. GGAggregate (GAlgebra (Rep a)) (HKDRep a) r
217+
218+
219+aggregateHKD :: forall a. ConstructableHKD a
220+ => AggregateHKD a -> HKD a Expr -> HKD a Aggregate
221+aggregateHKD f =
222+ ggaggregate @(GAlgebra (Rep a)) @(HKDRep a) @(HKD a Expr) @(HKD a Aggregate) HKD (\(HKD a) -> a)
223+ (f @(HKD a Aggregate))
224+
225+
226+data HKDRep :: Type -> K.Context -> Exp (Type -> Type)
227+type instance Eval (HKDRep a context) =
228+ GRecord (GMap (TColumn context) (Rep a))
src/Rel8/Table/Insert.hsdeleted−51
@@ -1,51 +0,0 @@
1−{-# language FlexibleContexts #-}
2−{-# language NamedFieldPuns #-}
3−{-# language TypeFamilies #-}
4−{-# language ViewPatterns #-}
5−
6−module Rel8.Table.Insert
7− ( toInsert
8− , toInsertDefaults
9− )
10−where
11−
12−-- base
13−import Prelude
14−
15−-- rel8
16−import Rel8.Expr ( Col(..) )
17−import Rel8.Kind.Necessity ( SNecessity( SOptional, SRequired ) )
18−import Rel8.Schema.HTable ( hfield, htabulate, hspecs )
19−import Rel8.Schema.Insert ( Inserts, Col(..) )
20−import Rel8.Schema.Spec ( SSpec(..) )
21−import Rel8.Table ( fromColumns, toColumns )
22−
23−
24−-- | @toInsert@ converts a 'Table' of 'Expr's into a 'Table' that can be used
25−-- with 'Rel8.insert'. This will override any columns that have default values
26−-- to use exactly what is given. If you want to use default values, you can
27−-- either override the result of @toInsert@, or use 'toInsertDefaults'.
28−toInsert :: Inserts exprs inserts => exprs -> inserts
29−toInsert (toColumns -> exprs) = fromColumns $ htabulate $ \field ->
30− case hfield hspecs field of
31− SSpec {necessity} -> case hfield exprs field of
32− DB expr -> case necessity of
33− SRequired -> RequiredInsert expr
34− SOptional -> OptionalInsert (Just expr)
35−
36−
37−-- | @toInsertDefaults@ converts a 'Table' of 'Expr's into a 'Table' that can
38−-- be used with 'Rel8.insert'. Any columns that have a default value will
39−-- override whatever is in the input expression.
40−--
41−-- One example where this is useful is for any table that has a special @id@
42−-- column, which has a default value to draw a new value from a sequence. If we
43−-- use 'toInsertDefaults', we can provide a dummy value that will be replaced
44−-- with a call to @DEFAULT@.
45−toInsertDefaults :: Inserts exprs inserts => exprs -> inserts
46−toInsertDefaults (toColumns -> exprs) = fromColumns $ htabulate $ \field ->
47− case hfield hspecs field of
48− SSpec {necessity} -> case hfield exprs field of
49− DB expr -> case necessity of
50− SRequired -> RequiredInsert expr
51− SOptional -> OptionalInsert Nothing
src/Rel8/Table/List.hs+79−45
@@ -1,3 +1,4 @@
1+{-# language DataKinds #-}
1{-# language FlexibleContexts #-}
2{-# language FlexibleContexts #-}
2{-# language FlexibleInstances #-}
3{-# language FlexibleInstances #-}
3{-# language MultiParamTypeClasses #-}
4{-# language MultiParamTypeClasses #-}
@@ -10,29 +11,36 @@
10
11
11module Rel8.Table.List
12module Rel8.Table.List
12 ( ListTable(..)
13 ( ListTable(..)
14+ , ($*)
13 , listTable
15 , listTable
16+ , nameListTable
14 )
17 )
15where
18where
16
19
17-- base
20-- base
18import Data.Functor.Identity ( Identity( Identity ) )
21import Data.Functor.Identity ( Identity( Identity ) )
19import Data.Kind ( Type )
22import Data.Kind ( Type )
20−import Data.Type.Equality ( (:~:)( Refl ) )
21import Prelude
23import Prelude
22
24
23-- rel8
25-- rel8
24−import Rel8.Expr ( Expr, Col(..) )
26+import Rel8.Expr ( Expr )
25import Rel8.Expr.Array ( sappend, sempty, slistOf )
27import Rel8.Expr.Array ( sappend, sempty, slistOf )
26import Rel8.Schema.Dict ( Dict( Dict ) )
28import Rel8.Schema.Dict ( Dict( Dict ) )
27import Rel8.Schema.HTable.List ( HListTable )
29import Rel8.Schema.HTable.List ( HListTable )
28−import Rel8.Schema.HTable.Vectorize ( happend, hempty, hvectorize )
30+import Rel8.Schema.HTable.Vectorize
31+ ( hvectorize, hunvectorize
32+ , happend, hempty
33+ , hproject, hcolumn
34+ )
35+import qualified Rel8.Schema.Kind as K
36+import Rel8.Schema.Name ( Name( Name ) )
29import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
37import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
30−import Rel8.Schema.Spec ( SSpec(..) )
38+import Rel8.Schema.Result ( vectorizer, unvectorizer )
31−import Rel8.Schema.Spec.ConstrainDBType ( dbTypeDict, dbTypeNullity )
39+import Rel8.Schema.Spec ( Spec(..) )
32−import Rel8.Schema.Reify ( hreify, hunreify )
33import Rel8.Table
40import Rel8.Table
34 ( Table, Context, Columns, fromColumns, toColumns
41 ( Table, Context, Columns, fromColumns, toColumns
35− , reify, unreify
42+ , FromExprs, fromResult, toResult
43+ , Transpose
36 )
44 )
37import Rel8.Table.Alternative
45import Rel8.Table.Alternative
38 ( AltTable, (<|>:)
46 ( AltTable, (<|>:)
@@ -40,76 +48,102 @@ import Rel8.Table.Alternative
40 )
48 )
41import Rel8.Table.Eq ( EqTable, eqTable )
49import Rel8.Table.Eq ( EqTable, eqTable )
42import Rel8.Table.Ord ( OrdTable, ordTable )
50import Rel8.Table.Ord ( OrdTable, ordTable )
43−import Rel8.Table.Recontextualize ( Recontextualize )
51+import Rel8.Table.Projection
44−import Rel8.Table.Unreify ( Unreifiable )
52+ ( Projectable, Projecting, Projection, project, apply
53+ )
54+import Rel8.Table.Serialize ( ToExprs )
45
55
46
56
47-- | A @ListTable@ value contains zero or more instances of @a@. You construct
57-- | A @ListTable@ value contains zero or more instances of @a@. You construct
48-- @ListTable@s with 'Rel8.many' or 'Rel8.listAgg'.
58-- @ListTable@s with 'Rel8.many' or 'Rel8.listAgg'.
49−type ListTable :: Type -> Type
59+type ListTable :: K.Context -> Type -> Type
50−newtype ListTable a = ListTable (HListTable (Columns a) (Col (Context a)))
60+newtype ListTable context a =
61+ ListTable (HListTable (Columns a) (Context a))
62+
51
63
64+instance Projectable (ListTable context) where
65+ project f (ListTable a) = ListTable (hproject (apply f) a)
52
66
53−instance (Table context a, Unreifiable context a) =>
67+
54− Table context (ListTable a)
68+instance (Table context a, context ~ context') =>
69+ Table context' (ListTable context a)
55 where
70 where
56− type Columns (ListTable a) = HListTable (Columns a)
71+ type Columns (ListTable context a) = HListTable (Columns a)
57− type Context (ListTable a) = Context a
72+ type Context (ListTable context a) = Context a
73+ type FromExprs (ListTable context a) = [FromExprs a]
74+ type Transpose to (ListTable context a) = ListTable to (Transpose to a)
58
75
59 fromColumns = ListTable
76 fromColumns = ListTable
60 toColumns (ListTable a) = a
77 toColumns (ListTable a) = a
61−
78+ fromResult = fmap (fromResult @_ @a) . hunvectorize unvectorizer
62− reify Refl (ListTable a) = ListTable (hreify a)
79+ toResult = hvectorize vectorizer . fmap (toResult @_ @a)
63− unreify Refl (ListTable a) = ListTable (hunreify a)
64
80
65
81
66−instance
82+instance (EqTable a, context ~ Expr) => EqTable (ListTable context a) where
67− ( Unreifiable from a, Unreifiable to b
68− , Recontextualize from to a b
69− )
70− => Recontextualize from to (ListTable a) (ListTable b)
71−
72−
73−instance EqTable a => EqTable (ListTable a) where
74 eqTable =
83 eqTable =
75 hvectorize
84 hvectorize
76− (\SSpec {} (Identity dict) -> case dbTypeDict dict of
85+ (\Spec {nullity} (Identity Dict) -> case nullity of
77− Dict -> case dbTypeNullity dict of
86+ Null -> Dict
78− Null -> Dict
87+ NotNull -> Dict)
79− NotNull -> Dict)
80 (Identity (eqTable @a))
88 (Identity (eqTable @a))
81
89
82
90
83−instance OrdTable a => OrdTable (ListTable a) where
91+instance (OrdTable a, context ~ Expr) => OrdTable (ListTable context a) where
84 ordTable =
92 ordTable =
85 hvectorize
93 hvectorize
86− (\SSpec {} (Identity dict) -> case dbTypeDict dict of
94+ (\Spec {nullity} (Identity Dict) -> case nullity of
87− Dict -> case dbTypeNullity dict of
95+ Null -> Dict
88− Null -> Dict
96+ NotNull -> Dict)
89− NotNull -> Dict)
90 (Identity (ordTable @a))
97 (Identity (ordTable @a))
91
98
92
99
93−instance AltTable ListTable where
100+instance (ToExprs exprs a, context ~ Expr) =>
101+ ToExprs (ListTable context exprs) [a]
102+
103+
104+instance context ~ Expr => AltTable (ListTable context) where
94 (<|>:) = (<>)
105 (<|>:) = (<>)
95
106
96
107
97−instance AlternativeTable ListTable where
108+instance context ~ Expr => AlternativeTable (ListTable context) where
98 emptyTable = mempty
109 emptyTable = mempty
99
110
100
111
101−instance Table Expr a => Semigroup (ListTable a) where
112+instance (context ~ Expr, Table Expr a) => Semigroup (ListTable context a)
102− ListTable as <> ListTable bs = ListTable $
113+ where
103− happend (\_ _ (DB a) (DB b) -> DB (sappend a b)) as bs
114+ ListTable as <> ListTable bs = ListTable $ happend (const sappend) as bs
115+
116+
117+instance (context ~ Expr, Table Expr a) =>
118+ Monoid (ListTable context a)
119+ where
120+ mempty = ListTable $ hempty $ \Spec {info} -> sempty info
104
121
105
122
106−instance Table Expr a => Monoid (ListTable a) where
123+-- | Project a single expression out of a 'ListTable'.
107− mempty = ListTable $ hempty $ \nullability info ->
124+($*) :: Projecting a (Expr b)
108− DB (sempty nullability info)
125+ => Projection a (Expr b) -> ListTable Expr a -> Expr [b]
126+f $* ListTable a = hcolumn $ hproject (apply f) a
127+infixl 4 $*
109
128
110
129
111−listTable :: Table Expr a => [a] -> ListTable a
130+-- | Construct a @ListTable@ from a list of expressions.
131+listTable :: Table Expr a => [a] -> ListTable Expr a
112listTable =
132listTable =
113 ListTable .
133 ListTable .
114− hvectorize (\SSpec {info} -> DB . slistOf info . fmap unDB) .
134+ hvectorize (\Spec {info} -> slistOf info) .
115 fmap toColumns
135 fmap toColumns
136+
137+
138+-- | Construct a 'ListTable' in the 'Name' context. This can be useful if you
139+-- have a 'ListTable' that you are storing in a table and need to construct a
140+-- 'TableSchema'.
141+nameListTable
142+ :: Table Name a
143+ => a -- ^ The names of the columns of elements of the list.
144+ -> ListTable Name a
145+nameListTable =
146+ ListTable .
147+ hvectorize (\_ (Identity (Name a)) -> Name a) .
148+ pure .
149+ toColumns
src/Rel8/Table/Maybe.hs+121−122
@@ -15,6 +15,7 @@ module Rel8.Table.Maybe
15 ( MaybeTable(..)
15 ( MaybeTable(..)
16 , maybeTable, nothingTable, justTable
16 , maybeTable, nothingTable, justTable
17 , isNothingTable, isJustTable
17 , isNothingTable, isJustTable
18+ , fromMaybeTable
18 , ($?)
19 , ($?)
19 , aggregateMaybeTable
20 , aggregateMaybeTable
20 , nameMaybeTable
21 , nameMaybeTable
@@ -22,35 +23,34 @@ module Rel8.Table.Maybe
22where
23where
23
24
24-- base
25-- base
25−import Data.Functor.Identity ( runIdentity )
26+import Data.Functor ( ($>) )
27+import Data.Functor.Identity ( Identity( Identity ) )
26import Data.Kind ( Type )
28import Data.Kind ( Type )
29+import Data.Maybe ( fromMaybe, isJust )
27import Prelude hiding ( null, undefined )
30import Prelude hiding ( null, undefined )
28
31
32+-- comonad
33+import Control.Comonad ( extract )
34+
29-- rel8
35-- rel8
30−import Rel8.Aggregate ( Aggregate, unsafeMakeAggregate )
36+import Rel8.Aggregate ( Aggregate )
31import Rel8.Expr ( Expr )
37import Rel8.Expr ( Expr )
38+import Rel8.Expr.Aggregate ( groupByExpr )
32import Rel8.Expr.Bool ( boolExpr )
39import Rel8.Expr.Bool ( boolExpr )
33import Rel8.Expr.Null ( isNull, isNonNull, null, nullify )
40import Rel8.Expr.Null ( isNull, isNonNull, null, nullify )
34−import Rel8.Expr.Opaleye ( fromPrimExpr, toPrimExpr )
41+import Rel8.Kind.Context ( Reifiable )
35−import Rel8.Schema.Context.Label
42+import Rel8.Schema.Dict ( Dict( Dict ) )
36− ( Labelable, HLabelable, hlabeler, hunlabeler
43+import qualified Rel8.Schema.Kind as K
37− )
38−import Rel8.Schema.Context.Nullify
39− ( Nullifiable, ConstrainTag
40− , HNullifiable, HConstrainTag
41− , hencodeTag, hdecodeTag
42− , hnullifier, hunnullifier
43− )
44−import Rel8.Schema.HTable ( HTable )
45import Rel8.Schema.HTable.Identity ( HIdentity(..) )
44import Rel8.Schema.HTable.Identity ( HIdentity(..) )
46import Rel8.Schema.HTable.Label ( hlabel, hunlabel )
45import Rel8.Schema.HTable.Label ( hlabel, hunlabel )
47import Rel8.Schema.HTable.Maybe ( HMaybeTable(..) )
46import Rel8.Schema.HTable.Maybe ( HMaybeTable(..) )
48−import Rel8.Schema.HTable.Nullify ( hnullify, hunnullify )
49import Rel8.Schema.Name ( Name )
47import Rel8.Schema.Name ( Name )
50−import Rel8.Schema.Null ( Nullify, Nullity( Null, NotNull ), Sql, nullable )
48+import Rel8.Schema.Null ( Nullity( Null, NotNull ), Sql, nullable )
49+import qualified Rel8.Schema.Null as N
51import Rel8.Table
50import Rel8.Table
52 ( Table, Columns, Context, fromColumns, toColumns
51 ( Table, Columns, Context, fromColumns, toColumns
53− , reify, unreify
52+ , FromExprs, fromResult, toResult
53+ , Transpose
54 )
54 )
55import Rel8.Table.Alternative
55import Rel8.Table.Alternative
56 ( AltTable, (<|>:)
56 ( AltTable, (<|>:)
@@ -59,14 +59,15 @@ import Rel8.Table.Alternative
59import Rel8.Table.Bool ( bool )
59import Rel8.Table.Bool ( bool )
60import Rel8.Table.Eq ( EqTable, eqTable )
60import Rel8.Table.Eq ( EqTable, eqTable )
61import Rel8.Table.Ord ( OrdTable, ordTable )
61import Rel8.Table.Ord ( OrdTable, ordTable )
62−import Rel8.Table.Recontextualize ( Recontextualize )
62+import Rel8.Table.Projection ( Projectable, project )
63−import Rel8.Table.Tag ( Tag(..), fromExpr, fromName )
63+import Rel8.Table.Nullify ( Nullify, aggregateNullify, guard )
64+import Rel8.Table.Serialize ( ToExprs )
64import Rel8.Table.Undefined ( undefined )
65import Rel8.Table.Undefined ( undefined )
65import Rel8.Type ( DBType )
66import Rel8.Type ( DBType )
66−import Rel8.Type.Tag ( MaybeTag )
67+import Rel8.Type.Tag ( MaybeTag( IsJust ) )
67
68
68-- semigroupoids
69-- semigroupoids
69−import Data.Functor.Apply ( Apply, (<.>), liftF2 )
70+import Data.Functor.Apply ( Apply, (<.>) )
70import Data.Functor.Bind ( Bind, (>>-) )
71import Data.Functor.Bind ( Bind, (>>-) )
71
72
72
73
@@ -78,170 +79,168 @@ import Data.Functor.Bind ( Bind, (>>-) )
78-- entirely of nulls, you can't distinguish if you matched an all null row, or
79-- entirely of nulls, you can't distinguish if you matched an all null row, or
79-- if the match failed. For this reason @MaybeTable@ contains an extra field -
80-- if the match failed. For this reason @MaybeTable@ contains an extra field -
80-- a "nullTag" - to track whether or not the outer join produced any rows.
81-- a "nullTag" - to track whether or not the outer join produced any rows.
81−type MaybeTable :: Type -> Type
82+type MaybeTable :: K.Context -> Type -> Type
82−data MaybeTable a = MaybeTable
83+data MaybeTable context a = MaybeTable
83− { tag :: Tag "isJust" (Maybe MaybeTag)
84+ { tag :: context (Maybe MaybeTag)
84− , just :: a
85+ , just :: Nullify context a
85 }
86 }
86 deriving stock Functor
87 deriving stock Functor
87
88
88
89
89−instance Apply MaybeTable where
90+instance Projectable (MaybeTable context) where
90− MaybeTable tag f <.> MaybeTable tag' a = MaybeTable (tag <> tag') (f a)
91+ project f (MaybeTable tag a) = MaybeTable tag (project f a)
92+
93+
94+instance context ~ Expr => Apply (MaybeTable context) where
95+ MaybeTable tag f <.> MaybeTable tag' a = MaybeTable (tag <> tag') (f <.> a)
91
96
92
97
93-- | Has the same behavior as the @Applicative@ instance for @Maybe@. See also:
98-- | Has the same behavior as the @Applicative@ instance for @Maybe@. See also:
94-- 'Rel8.traverseMaybeTable'.
99-- 'Rel8.traverseMaybeTable'.
95−instance Applicative MaybeTable where
100+instance context ~ Expr => Applicative (MaybeTable context) where
96 (<*>) = (<.>)
101 (<*>) = (<.>)
97 pure = justTable
102 pure = justTable
98
103
99
104
100−instance Bind MaybeTable where
105+instance context ~ Expr => Bind (MaybeTable context) where
101− MaybeTable tag a >>- f = case f a of
106+ MaybeTable tag a >>- f = case f (extract a) of
102 MaybeTable tag' b -> MaybeTable (tag <> tag') b
107 MaybeTable tag' b -> MaybeTable (tag <> tag') b
103
108
104
109
105−-- | Has the same behavior as the @Monad@ instance for @Maybe@. See also:
110+-- | Has the same behavior as the @Monad@ instance for @Maybe@.
106−-- 'Rel8.bindMaybeTable'.
111+instance context ~ Expr => Monad (MaybeTable context) where
107−instance Monad MaybeTable where
108 (>>=) = (>>-)
112 (>>=) = (>>-)
109
113
110
114
111−instance AltTable MaybeTable where
115+instance context ~ Expr => AltTable (MaybeTable context) where
112− ma@(MaybeTable tag a) <|>: MaybeTable tag' b = MaybeTable
116+ ma <|>: mb = bool ma mb (isNothingTable ma)
113− { tag = (tag <> tag')
114− { expr = boolExpr (expr tag) (expr tag') condition
115− }
116− , just = bool a b condition
117− }
118− where
119− condition = isNothingTable ma
120
117
121
118
122−instance AlternativeTable MaybeTable where
119+instance context ~ Expr => AlternativeTable (MaybeTable context) where
123 emptyTable = nothingTable
120 emptyTable = nothingTable
124
121
125
122
126−instance (Table Expr a, Semigroup a) => Semigroup (MaybeTable a) where
123+instance (context ~ Expr, Table Expr a, Semigroup a) =>
124+ Semigroup (MaybeTable context a)
125+ where
127 ma <> mb = maybeTable mb (\a -> maybeTable ma (justTable . (a <>)) mb) ma
126 ma <> mb = maybeTable mb (\a -> maybeTable ma (justTable . (a <>)) mb) ma
128
127
129
128
130−instance (Table Expr a, Semigroup a) => Monoid (MaybeTable a) where
129+instance (context ~ Expr, Table Expr a, Semigroup a) =>
130+ Monoid (MaybeTable context a)
131+ where
131 mempty = nothingTable
132 mempty = nothingTable
132
133
133
134
134−instance
135+instance (Table context a, Reifiable context, context ~ context') =>
135− ( Table context a
136+ Table context' (MaybeTable context a)
136− , Labelable context, Nullifiable context
137− , ConstrainTag context MaybeTag
138− ) => Table context (MaybeTable a)
139 where
137 where
140− type Columns (MaybeTable a) = HMaybeTable (Columns a)
138+ type Columns (MaybeTable context a) = HMaybeTable (Columns a)
141− type Context (MaybeTable a) = Context a
139+ type Context (MaybeTable context a) = Context a
140+ type FromExprs (MaybeTable context a) = Maybe (FromExprs a)
141+ type Transpose to (MaybeTable context a) = MaybeTable to (Transpose to a)
142+
143+ toColumns MaybeTable {tag, just} = HMaybeTable
144+ { htag = hlabel $ HIdentity tag
145+ , hjust = hlabel $ guard tag isJust isNonNull $ toColumns just
146+ }
142
147
143− toColumns = toColumns1 toColumns
148+ fromColumns HMaybeTable {htag, hjust} = MaybeTable
144− fromColumns = fromColumns1 fromColumns
149+ { tag = unHIdentity $ hunlabel htag
145− reify = fmap fmap reify
150+ , just = fromColumns $ hunlabel hjust
146− unreify = fmap fmap unreify
151+ }
147
152
153+ toResult ma = HMaybeTable
154+ { htag = hlabel (HIdentity (Identity (IsJust <$ ma)))
155+ , hjust = hlabel (toResult @_ @(Nullify context a) ma)
156+ }
157+
158+ fromResult HMaybeTable {htag, hjust} = case hunlabel htag of
159+ HIdentity (Identity tag) -> tag $>
160+ fromMaybe err (fromResult @_ @(Nullify context a) (hunlabel hjust))
161+ where
162+ err = error "Maybe.fromColumns: mismatch between tag and data"
148
163
149−instance
164+
150− ( Labelable from, Nullifiable from, ConstrainTag from MaybeTag
165+instance (EqTable a, context ~ Expr) => EqTable (MaybeTable context a) where
151− , Labelable to, Nullifiable to, ConstrainTag to MaybeTag
166+ eqTable = HMaybeTable
152− , Recontextualize from to a b
167+ { htag = hlabel (HIdentity Dict)
153− )
168+ , hjust = hlabel (eqTable @(Nullify context a))
154− => Recontextualize from to (MaybeTable a) (MaybeTable b)
169+ }
155
170
156
171
157−instance EqTable a => EqTable (MaybeTable a) where
172+instance (OrdTable a, context ~ Expr) => OrdTable (MaybeTable context a) where
158− eqTable = toColumns1 id (justTable (eqTable @a))
173+ ordTable = HMaybeTable
174+ { htag = hlabel (HIdentity Dict)
175+ , hjust = hlabel (ordTable @(Nullify context a))
176+ }
159
177
160
178
161−instance OrdTable a => OrdTable (MaybeTable a) where
179+instance (ToExprs exprs a, context ~ Expr) =>
162− ordTable = toColumns1 id (justTable (ordTable @a))
180+ ToExprs (MaybeTable context exprs) (Maybe a)
163
181
164
182
165-- | Check if a @MaybeTable@ is absent of any row. Like 'Data.Maybe.isNothing'.
183-- | Check if a @MaybeTable@ is absent of any row. Like 'Data.Maybe.isNothing'.
166−isNothingTable :: MaybeTable a -> Expr Bool
184+isNothingTable :: MaybeTable Expr a -> Expr Bool
167−isNothingTable (MaybeTable tag _) = isNull (expr tag)
185+isNothingTable (MaybeTable tag _) = isNull tag
168
186
169
187
170-- | Check if a @MaybeTable@ contains a row. Like 'Data.Maybe.isJust'.
188-- | Check if a @MaybeTable@ contains a row. Like 'Data.Maybe.isJust'.
171−isJustTable :: MaybeTable a -> Expr Bool
189+isJustTable :: MaybeTable Expr a -> Expr Bool
172−isJustTable (MaybeTable tag _) = isNonNull (expr tag)
190+isJustTable (MaybeTable tag _) = isNonNull tag
173
191
174
192
175-- | Perform case analysis on a 'MaybeTable'. Like 'maybe'.
193-- | Perform case analysis on a 'MaybeTable'. Like 'maybe'.
176−maybeTable :: Table Expr b => b -> (a -> b) -> MaybeTable a -> b
194+maybeTable :: Table Expr b => b -> (a -> b) -> MaybeTable Expr a -> b
177−maybeTable b f ma@(MaybeTable _ a) = bool (f a) b (isNothingTable ma)
195+maybeTable b f ma@(MaybeTable _ a) = bool (f (extract a)) b (isNothingTable ma)
178{-# INLINABLE maybeTable #-}
196{-# INLINABLE maybeTable #-}
179
197
180
198
181-- | The null table. Like 'Nothing'.
199-- | The null table. Like 'Nothing'.
182−nothingTable :: Table Expr a => MaybeTable a
200+nothingTable :: Table Expr a => MaybeTable Expr a
183−nothingTable = MaybeTable (fromExpr null) undefined
201+nothingTable = MaybeTable null (pure undefined)
184
202
185
203
186-- | Lift any table into 'MaybeTable'. Like 'Just'. Note you can also use
204-- | Lift any table into 'MaybeTable'. Like 'Just'. Note you can also use
187-- 'pure'.
205-- 'pure'.
188−justTable :: a -> MaybeTable a
206+justTable :: a -> MaybeTable Expr a
189−justTable = MaybeTable (fromExpr mempty)
207+justTable = MaybeTable mempty . pure
208+
209+
210+-- | 'Data.Maybe.fromMaybe' for 'MaybeTable's.
211+fromMaybeTable :: Table Expr a => a -> MaybeTable Expr a -> a
212+fromMaybeTable fallback = maybeTable fallback id
190
213
191
214
192-- | Project a single expression out of a 'MaybeTable'. You can think of this
215-- | Project a single expression out of a 'MaybeTable'. You can think of this
193-- operator like the '$' operator, but it also has the ability to return
216-- operator like the '$' operator, but it also has the ability to return
194-- @null@.
217-- @null@.
195($?) :: forall a b. Sql DBType b
218($?) :: forall a b. Sql DBType b
196− => (a -> Expr b) -> MaybeTable a -> Expr (Nullify b)
219+ => (a -> Expr b) -> MaybeTable Expr a -> Expr (N.Nullify b)
197f $? ma@(MaybeTable _ a) = case nullable @b of
220f $? ma@(MaybeTable _ a) = case nullable @b of
198− Null -> boolExpr (f a) null (isNothingTable ma)
221+ Null -> boolExpr (f (extract a)) null (isNothingTable ma)
199− NotNull -> boolExpr (nullify (f a)) null (isNothingTable ma)
222+ NotNull -> boolExpr (nullify (f (extract a))) null (isNothingTable ma)
200infixl 4 $?
223infixl 4 $?
201
224
202
225
226+-- | Lift an aggregating function to operate on a 'MaybeTable'.
227+-- @nothingTable@s and @justTable@s are grouped separately.
203aggregateMaybeTable :: ()
228aggregateMaybeTable :: ()
204− => (a -> Aggregate b) -> MaybeTable a -> Aggregate (MaybeTable b)
229+ => (exprs -> aggregates)
205−aggregateMaybeTable f MaybeTable {tag = tag@Tag {aggregator, expr}, just} =
230+ -> MaybeTable Expr exprs
206− liftF2 MaybeTable (tag <$ aggregate) (f just)
231+ -> MaybeTable Aggregate aggregates
207− where
232+aggregateMaybeTable f (MaybeTable tag a) =
208− aggregate = unsafeMakeAggregate toPrimExpr fromPrimExpr aggregator expr
233+ MaybeTable (groupByExpr tag) (aggregateNullify f a)
209−
234+
210−
235+
211−nameMaybeTable :: Name (Maybe MaybeTag) -> a -> MaybeTable a
236+-- | Construct a 'MaybeTable' in the 'Name' context. This can be useful if you
212−nameMaybeTable = MaybeTable . fromName
237+-- have a 'MaybeTable' that you are storing in a table and need to construct a
213−
238+-- 'TableSchema'.
214−
239+nameMaybeTable
215−toColumns1 ::
240+ :: Name (Maybe MaybeTag)
216− ( HTable t
241+ -- ^ The name of the column to track whether a row is a 'justTable' or
217− , HConstrainTag context MaybeTag
242+ -- 'nothingTable'.
218− , HLabelable context
243+ -> a
219− , HNullifiable context
244+ -- ^ Names of the columns in @a@.
220− )
245+ -> MaybeTable Name a
221− => (a -> t context)
246+nameMaybeTable tag = MaybeTable tag . pure
222− -> MaybeTable a
223− -> HMaybeTable t context
224−toColumns1 f MaybeTable {tag, just} = HMaybeTable
225− { htag
226− , hjust = hlabel hlabeler $ hnullify (hnullifier tag isNonNull) $ f just
227− }
228− where
229− htag = HIdentity (hencodeTag tag)
230−
231−
232−fromColumns1 ::
233− ( HTable t
234− , HConstrainTag context MaybeTag
235− , HLabelable context
236− , HNullifiable context
237− )
238− => (t context -> a)
239− -> HMaybeTable t context
240− -> MaybeTable a
241−fromColumns1 f HMaybeTable {htag = HIdentity htag, hjust} = MaybeTable
242− { tag
243− , just = f $ runIdentity $
244− hunnullify (\a -> pure . hunnullifier a) (hunlabel hunlabeler hjust)
245− }
246− where
247− tag = hdecodeTag htag
src/Rel8/Table/Name.hs+37−26
@@ -1,14 +1,17 @@
1+{-# language DataKinds #-}
1{-# language FlexibleContexts #-}
2{-# language FlexibleContexts #-}
3+{-# language FlexibleInstances #-}
4+{-# language MultiParamTypeClasses #-}
2{-# language NamedFieldPuns #-}
5{-# language NamedFieldPuns #-}
3{-# language ScopedTypeVariables #-}
6{-# language ScopedTypeVariables #-}
4{-# language TypeApplications #-}
7{-# language TypeApplications #-}
5{-# language TypeFamilies #-}
8{-# language TypeFamilies #-}
9+{-# language UndecidableInstances #-}
6{-# language ViewPatterns #-}
10{-# language ViewPatterns #-}
7
11
8module Rel8.Table.Name
12module Rel8.Table.Name
9 ( namesFromLabels
13 ( namesFromLabels
10 , namesFromLabelsWith
14 , namesFromLabelsWith
11− , showExprs
12 , showLabels
15 , showLabels
13 , showNames
16 , showNames
14 )
17 )
@@ -17,52 +20,60 @@ where
17-- base
20-- base
18import Data.Foldable ( fold )
21import Data.Foldable ( fold )
19import Data.Functor.Const ( Const( Const ), getConst )
22import Data.Functor.Const ( Const( Const ), getConst )
20−import Data.List.NonEmpty ( NonEmpty, intersperse )
23+import Data.List.NonEmpty ( NonEmpty, intersperse, nonEmpty )
24+import Data.Maybe ( fromMaybe )
21import Prelude
25import Prelude
22
26
23−-- casing
24−import Text.Casing ( quietSnake )
25−
26−-- opaleye
27−import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
28−
29-- rel8
27-- rel8
30−import Rel8.Expr ( Expr, Col(..) )
31−import Rel8.Expr.Opaleye ( toPrimExpr )
32−import Rel8.Kind.Labels ( renderLabels )
33import Rel8.Schema.HTable ( htabulate, htabulateA, hfield, hspecs )
28import Rel8.Schema.HTable ( htabulate, htabulateA, hfield, hspecs )
34−import Rel8.Schema.Name ( Name, Col(..) )
29+import Rel8.Schema.Name ( Name( Name ) )
35−import Rel8.Schema.Spec ( SSpec(..) )
30+import Rel8.Schema.Spec ( Spec(..) )
36−import Rel8.Table ( Table, Columns, Context, fromColumns, toColumns )
31+import Rel8.Table ( Table(..) )
37
32
38
33
34+-- | Construct a table in the 'Name' context containing the names of all
35+-- columns. Nested column names will be combined with @/@.
36+--
37+-- See also: 'namesFromLabelsWith'.
39namesFromLabels :: Table Name a => a
38namesFromLabels :: Table Name a => a
40namesFromLabels = namesFromLabelsWith go
39namesFromLabels = namesFromLabelsWith go
41 where
40 where
42− go = fold . intersperse "/" . fmap quietSnake
41+ go = fold . intersperse "/"
43
42
44
43
44+-- | Construct a table in the 'Name' context containing the names of all
45+-- columns. The supplied function can be used to transform column names.
46+--
47+-- This function can be used to generically derive the columns for a
48+-- 'TableSchema'. For example,
49+--
50+-- @
51+-- myTableSchema :: TableSchema (MyTable Name)
52+-- myTableSchema = TableSchema
53+-- { columns = namesFromLabelsWith last
54+-- }
55+-- @
56+--
57+-- will construct a 'TableSchema' where each columns names exactly corresponds
58+-- to the name of the Haskell field.
45namesFromLabelsWith :: Table Name a
59namesFromLabelsWith :: Table Name a
46 => (NonEmpty String -> String) -> a
60 => (NonEmpty String -> String) -> a
47namesFromLabelsWith f = fromColumns $ htabulate $ \field ->
61namesFromLabelsWith f = fromColumns $ htabulate $ \field ->
48 case hfield hspecs field of
62 case hfield hspecs field of
49− SSpec {labels} -> NameCol (f (renderLabels labels))
63+ Spec {labels} -> Name (f (renderLabels labels))
50−
51−
52−showExprs :: Table Expr a => a -> [(String, Opaleye.PrimExpr)]
53−showExprs as = case (namesFromLabels, toColumns as) of
54− (names, exprs) -> getConst $ htabulateA $ \field ->
55− case (hfield names field, hfield exprs field) of
56− (NameCol name, DB expr) -> Const [(name, toPrimExpr expr)]
57
64
58
65
59showLabels :: forall a. Table (Context a) a => a -> [NonEmpty String]
66showLabels :: forall a. Table (Context a) a => a -> [NonEmpty String]
60showLabels _ = getConst $
67showLabels _ = getConst $
61 htabulateA @(Columns a) $ \field -> case hfield hspecs field of
68 htabulateA @(Columns a) $ \field -> case hfield hspecs field of
62− SSpec {labels} -> Const [renderLabels labels]
69+ Spec {labels} -> Const (pure (renderLabels labels))
63
70
64
71
65−showNames :: forall a. Table Name a => a -> [String]
72+showNames :: forall a. Table Name a => a -> NonEmpty String
66showNames (toColumns -> names) = getConst $
73showNames (toColumns -> names) = getConst $
67 htabulateA @(Columns a) $ \field -> case hfield names field of
74 htabulateA @(Columns a) $ \field -> case hfield names field of
68− NameCol name -> Const [name]
75+ Name name -> Const (pure name)
76+
77+
78+renderLabels :: [String] -> NonEmpty String
79+renderLabels labels = fromMaybe (pure "anon") (nonEmpty labels )
src/Rel8/Table/NonEmpty.hs+79−44
@@ -3,7 +3,6 @@
3{-# language FlexibleInstances #-}
3{-# language FlexibleInstances #-}
4{-# language MultiParamTypeClasses #-}
4{-# language MultiParamTypeClasses #-}
5{-# language NamedFieldPuns #-}
5{-# language NamedFieldPuns #-}
6−{-# language QuantifiedConstraints #-}
7{-# language ScopedTypeVariables #-}
6{-# language ScopedTypeVariables #-}
8{-# language StandaloneKindSignatures #-}
7{-# language StandaloneKindSignatures #-}
9{-# language TypeApplications #-}
8{-# language TypeApplications #-}
@@ -12,8 +11,9 @@
12
11
13module Rel8.Table.NonEmpty
12module Rel8.Table.NonEmpty
14 ( NonEmptyTable(..)
13 ( NonEmptyTable(..)
15− , HNonEmptyTable
14+ , ($+)
16 , nonEmptyTable
15 , nonEmptyTable
16+ , nameNonEmptyTable
17 )
17 )
18where
18where
19
19
@@ -21,88 +21,123 @@ where
21import Data.Functor.Identity ( Identity( Identity ) )
21import Data.Functor.Identity ( Identity( Identity ) )
22import Data.Kind ( Type )
22import Data.Kind ( Type )
23import Data.List.NonEmpty ( NonEmpty )
23import Data.List.NonEmpty ( NonEmpty )
24−import Data.Type.Equality ( (:~:)( Refl ) )
24+import Prelude hiding ( id )
25−import Prelude
26
25
27-- rel8
26-- rel8
28−import Rel8.Expr ( Expr, Col(..) )
27+import Rel8.Expr ( Expr )
29import Rel8.Expr.Array ( sappend1, snonEmptyOf )
28import Rel8.Expr.Array ( sappend1, snonEmptyOf )
30import Rel8.Schema.Dict ( Dict( Dict ) )
29import Rel8.Schema.Dict ( Dict( Dict ) )
31import Rel8.Schema.HTable.NonEmpty ( HNonEmptyTable )
30import Rel8.Schema.HTable.NonEmpty ( HNonEmptyTable )
32−import Rel8.Schema.HTable.Vectorize ( happend, hvectorize )
31+import Rel8.Schema.HTable.Vectorize
32+ ( hvectorize, hunvectorize
33+ , happend
34+ , hproject, hcolumn
35+ )
36+import qualified Rel8.Schema.Kind as K
37+import Rel8.Schema.Name ( Name( Name ) )
33import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
38import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
34−import Rel8.Schema.Reify ( hreify, hunreify )
39+import Rel8.Schema.Result ( vectorizer, unvectorizer )
35−import Rel8.Schema.Spec ( SSpec(..) )
40+import Rel8.Schema.Spec ( Spec(..) )
36−import Rel8.Schema.Spec.ConstrainDBType ( dbTypeDict, dbTypeNullity )
37import Rel8.Table
41import Rel8.Table
38 ( Table, Context, Columns, fromColumns, toColumns
42 ( Table, Context, Columns, fromColumns, toColumns
39− , reify, unreify
43+ , FromExprs, fromResult, toResult
44+ , Transpose
40 )
45 )
41import Rel8.Table.Alternative ( AltTable, (<|>:) )
46import Rel8.Table.Alternative ( AltTable, (<|>:) )
42import Rel8.Table.Eq ( EqTable, eqTable )
47import Rel8.Table.Eq ( EqTable, eqTable )
43import Rel8.Table.Ord ( OrdTable, ordTable )
48import Rel8.Table.Ord ( OrdTable, ordTable )
44−import Rel8.Table.Recontextualize ( Recontextualize )
49+import Rel8.Table.Projection
45−import Rel8.Table.Unreify ( Unreifiable )
50+ ( Projectable, Projecting, Projection, project, apply
51+ )
52+import Rel8.Table.Serialize ( ToExprs )
46
53
47
54
48-- | A @NonEmptyTable@ value contains one or more instances of @a@. You
55-- | A @NonEmptyTable@ value contains one or more instances of @a@. You
49-- construct @NonEmptyTable@s with 'Rel8.some' or 'nonEmptyAgg'.
56-- construct @NonEmptyTable@s with 'Rel8.some' or 'nonEmptyAgg'.
50−type NonEmptyTable :: Type -> Type
57+type NonEmptyTable :: K.Context -> Type -> Type
51−newtype NonEmptyTable a =
58+newtype NonEmptyTable context a =
52− NonEmptyTable (HNonEmptyTable (Columns a) (Col (Context a)))
59+ NonEmptyTable (HNonEmptyTable (Columns a) (Context a))
60+
53
61
62+instance Projectable (NonEmptyTable context) where
63+ project f (NonEmptyTable a) = NonEmptyTable (hproject (apply f) a)
54
64
55−instance (Table context a, Unreifiable context a) =>
65+
56− Table context (NonEmptyTable a)
66+instance (Table context a, context ~ context') =>
67+ Table context' (NonEmptyTable context a)
57 where
68 where
58− type Columns (NonEmptyTable a) = HNonEmptyTable (Columns a)
69+ type Columns (NonEmptyTable context a) = HNonEmptyTable (Columns a)
59− type Context (NonEmptyTable a) = Context a
70+ type Context (NonEmptyTable context a) = Context a
71+ type FromExprs (NonEmptyTable context a) = NonEmpty (FromExprs a)
72+ type Transpose to (NonEmptyTable context a) =
73+ NonEmptyTable to (Transpose to a)
60
74
61 fromColumns = NonEmptyTable
75 fromColumns = NonEmptyTable
62 toColumns (NonEmptyTable a) = a
76 toColumns (NonEmptyTable a) = a
63−
77+ fromResult = fmap (fromResult @_ @a) . hunvectorize unvectorizer
64− reify Refl (NonEmptyTable a) = NonEmptyTable (hreify a)
78+ toResult = hvectorize vectorizer . fmap (toResult @_ @a)
65− unreify Refl (NonEmptyTable a) = NonEmptyTable (hunreify a)
66
79
67
80
68−instance
81+instance (EqTable a, context ~ Expr) =>
69− ( Unreifiable from a, Unreifiable to b
82+ EqTable (NonEmptyTable context a)
70− , Recontextualize from to a b
83+ where
71− )
72− => Recontextualize from to (NonEmptyTable a) (NonEmptyTable b)
73−
74−
75−instance EqTable a => EqTable (NonEmptyTable a) where
76 eqTable =
84 eqTable =
77 hvectorize
85 hvectorize
78− (\SSpec {} (Identity dict) -> case dbTypeDict dict of
86+ (\Spec {nullity} (Identity Dict) -> case nullity of
79− Dict -> case dbTypeNullity dict of
87+ Null -> Dict
80− Null -> Dict
88+ NotNull -> Dict)
81− NotNull -> Dict)
82 (Identity (eqTable @a))
89 (Identity (eqTable @a))
83
90
84
91
85−instance OrdTable a => OrdTable (NonEmptyTable a) where
92+instance (OrdTable a, context ~ Expr) =>
93+ OrdTable (NonEmptyTable context a)
94+ where
86 ordTable =
95 ordTable =
87 hvectorize
96 hvectorize
88− (\SSpec {} (Identity dict) -> case dbTypeDict dict of
97+ (\Spec {nullity} (Identity Dict) -> case nullity of
89− Dict -> case dbTypeNullity dict of
98+ Null -> Dict
90− Null -> Dict
99+ NotNull -> Dict)
91− NotNull -> Dict)
92 (Identity (ordTable @a))
100 (Identity (ordTable @a))
93
101
94
102
95−instance AltTable NonEmptyTable where
103+instance (ToExprs exprs a, context ~ Expr) =>
104+ ToExprs (NonEmptyTable context exprs) (NonEmpty a)
105+
106+
107+instance context ~ Expr => AltTable (NonEmptyTable context) where
96 (<|>:) = (<>)
108 (<|>:) = (<>)
97
109
98
110
99−instance Table Expr a => Semigroup (NonEmptyTable a) where
111+instance (Table Expr a, context ~ Expr) => Semigroup (NonEmptyTable context a)
112+ where
100 NonEmptyTable as <> NonEmptyTable bs = NonEmptyTable $
113 NonEmptyTable as <> NonEmptyTable bs = NonEmptyTable $
101− happend (\_ _ (DB a) (DB b) -> DB (sappend1 a b)) as bs
114+ happend (const sappend1) as bs
115+
102
116
117+-- | Project a single expression out of a 'NonEmptyTable'.
118+($+) :: Projecting a (Expr b)
119+ => Projection a (Expr b) -> NonEmptyTable Expr a -> Expr (NonEmpty b)
120+f $+ NonEmptyTable a = hcolumn $ hproject (apply f) a
121+infixl 4 $+
103
122
104−nonEmptyTable :: Table Expr a => NonEmpty a -> NonEmptyTable a
123+
124+-- | Construct a @NonEmptyTable@ from a non-empty list of expressions.
125+nonEmptyTable :: Table Expr a => NonEmpty a -> NonEmptyTable Expr a
105nonEmptyTable =
126nonEmptyTable =
106 NonEmptyTable .
127 NonEmptyTable .
107− hvectorize (\SSpec {info} -> DB . snonEmptyOf info . fmap unDB) .
128+ hvectorize (\Spec {info} -> snonEmptyOf info) .
108 fmap toColumns
129 fmap toColumns
130+
131+
132+-- | Construct a 'NonEmptyTable' in the 'Name' context. This can be useful if
133+-- you have a 'NonEmptyTable' that you are storing in a table and need to
134+-- construct a 'TableSchema'.
135+nameNonEmptyTable
136+ :: Table Name a
137+ => a -- ^ The names of the columns of elements of the list.
138+ -> NonEmptyTable Name a
139+nameNonEmptyTable =
140+ NonEmptyTable .
141+ hvectorize (\_ (Identity (Name a)) -> Name a) .
142+ pure .
143+ toColumns
src/Rel8/Table/Null.hsnew file+147
@@ -0,0 +1,147 @@
1+{-# language DataKinds #-}
2+{-# language FlexibleContexts #-}
3+{-# language FlexibleInstances #-}
4+{-# language MultiParamTypeClasses #-}
5+{-# language ScopedTypeVariables #-}
6+{-# language StandaloneKindSignatures #-}
7+{-# language TypeApplications #-}
8+{-# language TypeFamilies #-}
9+{-# language UndecidableInstances #-}
10+
11+module Rel8.Table.Null
12+ ( NullTable(..)
13+ , nullableTable, nullTable, nullifyTable, unsafeUnnullifyTable
14+ , isNullTable, isNonNullTable
15+ , nameNullTable
16+ , toMaybeTable, toNullTable
17+ )
18+where
19+
20+-- base
21+import Data.Kind ( Type )
22+import Prelude hiding ( null, undefined )
23+
24+-- comonad
25+import Control.Comonad ( extract )
26+
27+-- rel8
28+import Rel8.Expr ( Expr )
29+import Rel8.Expr.Bool ( not_ )
30+import Rel8.Kind.Context ( Reifiable )
31+import qualified Rel8.Schema.Kind as K
32+import Rel8.Schema.Name ( Name )
33+import Rel8.Table
34+ ( Table, Columns, Context, fromColumns, toColumns
35+ , FromExprs, fromResult, toResult
36+ , Transpose
37+ )
38+import Rel8.Table.Alternative
39+ ( AltTable, (<|>:)
40+ , AlternativeTable, emptyTable
41+ )
42+import Rel8.Table.Bool ( bool )
43+import Rel8.Table.Eq ( EqTable, eqTable )
44+import Rel8.Table.Maybe ( MaybeTable, justTable, maybeTable, nothingTable )
45+import Rel8.Table.Nullify ( Nullify, isNull )
46+import Rel8.Table.Ord ( OrdTable, ordTable )
47+import Rel8.Table.Projection ( Projectable, project )
48+import Rel8.Table.Serialize ( ToExprs )
49+import Rel8.Table.Undefined ( undefined )
50+
51+
52+-- | @NullTable t@ is the table @t@, but where all the columns in @t@ have the
53+-- possibility of being 'Rel8.null'. This is very similar to
54+-- 'Rel8.MaybeTable', except that it does not use an extra tag field, so it
55+-- cannot distinguish between @Nothing@ and @Just Nothing@ if nested. In other
56+-- words, if all of the columns of the @t@ passed to @NullTable@ are already
57+-- nullable, then @NullTable@ has no effect.
58+type NullTable :: K.Context -> Type -> Type
59+newtype NullTable context a = NullTable (Nullify context a)
60+
61+
62+instance Projectable (NullTable context) where
63+ project f (NullTable a) = NullTable (project f a)
64+
65+
66+instance context ~ Expr => AltTable (NullTable context) where
67+ ma <|>: mb = bool ma mb (isNullTable ma)
68+
69+
70+instance context ~ Expr => AlternativeTable (NullTable context) where
71+ emptyTable = nullTable
72+
73+
74+instance (Table context a, Reifiable context, context ~ context') =>
75+ Table context' (NullTable context a)
76+ where
77+ type Columns (NullTable context a) = Columns (Nullify context a)
78+ type Context (NullTable context a) = Context (Nullify context a)
79+ type FromExprs (NullTable context a) = FromExprs (Nullify context a)
80+ type Transpose to (NullTable context a) = NullTable to (Transpose to a)
81+
82+ toColumns (NullTable a) = toColumns a
83+ fromColumns = NullTable . fromColumns
84+
85+ toResult = toResult @_ @(Nullify context a)
86+ fromResult = fromResult @_ @(Nullify context a)
87+
88+
89+instance (EqTable a, context ~ Expr) => EqTable (NullTable context a) where
90+ eqTable = eqTable @(Nullify context a)
91+
92+
93+instance (OrdTable a, context ~ Expr) => OrdTable (NullTable context a) where
94+ ordTable = ordTable @(Nullify context a)
95+
96+
97+instance (ToExprs exprs a, context ~ Expr) =>
98+ ToExprs (NullTable context exprs) (Maybe a)
99+
100+
101+-- | Check if any of the non-nullable fields of @a@ are 'Rel8.null' under the
102+-- 'NullTable'. Returns 'Rel8.false' if @a@ has no non-nullable fields.
103+isNullTable :: Table Expr a => NullTable Expr a -> Expr Bool
104+isNullTable (NullTable a) = isNull a
105+
106+
107+-- | The inverse of 'isNullTable'.
108+isNonNullTable :: Table Expr a => NullTable Expr a -> Expr Bool
109+isNonNullTable = not_ . isNullTable
110+
111+
112+-- | Like 'Rel8.nullable'.
113+nullableTable :: (Table Expr a, Table Expr b)
114+ => b -> (a -> b) -> NullTable Expr a -> b
115+nullableTable b f ma@(NullTable a) = bool (f (extract a)) b (isNullTable ma)
116+
117+
118+-- | The null table. Like 'Rel8.null'.
119+nullTable :: Table Expr a => NullTable Expr a
120+nullTable = NullTable (pure undefined)
121+
122+
123+-- | Lift any table into 'NullTable'. Like 'Rel8.nullify'.
124+nullifyTable :: a -> NullTable Expr a
125+nullifyTable = NullTable . pure
126+
127+
128+unsafeUnnullifyTable :: NullTable Expr a -> a
129+unsafeUnnullifyTable (NullTable a) = extract a
130+
131+
132+-- | Construct a 'NullTable' in the 'Name' context. This can be useful if you
133+-- have a 'NullTable' that you are storing in a table and need to construct a
134+-- 'TableSchema'.
135+nameNullTable :: a -> NullTable Name a
136+nameNullTable = NullTable . pure
137+
138+
139+-- | Convert a 'NullTable' to a 'MaybeTable'.
140+toMaybeTable :: Table Expr a => NullTable Expr a -> MaybeTable Expr a
141+toMaybeTable = nullableTable nothingTable justTable
142+
143+
144+-- | Convert a 'MaybeTable' to a 'NullTable'. Note that if the underlying @a@
145+-- has no non-nullable fields, this is a lossy conversion.
146+toNullTable :: Table Expr a => MaybeTable Expr a -> NullTable Expr a
147+toNullTable = maybeTable nullTable nullifyTable
src/Rel8/Table/Nullify.hsnew file+211
@@ -0,0 +1,211 @@
1+{-# language DataKinds #-}
2+{-# language FlexibleContexts #-}
3+{-# language FlexibleInstances #-}
4+{-# language LambdaCase #-}
5+{-# language MultiParamTypeClasses #-}
6+{-# language NamedFieldPuns #-}
7+{-# language ScopedTypeVariables #-}
8+{-# language StandaloneKindSignatures #-}
9+{-# language TypeApplications #-}
10+{-# language TypeFamilies #-}
11+{-# language UndecidableInstances #-}
12+
13+module Rel8.Table.Nullify
14+ ( Nullify
15+ , aggregateNullify
16+ , guard
17+ , isNull
18+ )
19+where
20+
21+-- base
22+import Control.Applicative ( liftA2 )
23+import Data.Functor.Const ( Const( Const ), getConst )
24+import Data.Functor.Identity ( runIdentity )
25+import Data.Kind ( Type )
26+import Prelude
27+
28+-- comonad
29+import Control.Comonad ( Comonad, duplicate, extract, ComonadApply, (<@>) )
30+
31+-- rel8
32+import Rel8.Aggregate ( Aggregate )
33+import Rel8.Expr ( Expr )
34+import Rel8.Expr.Bool ( (||.), false )
35+import qualified Rel8.Expr.Null as Expr
36+import Rel8.Kind.Context ( Reifiable, contextSing )
37+import Rel8.Schema.Context.Nullify
38+ ( Nullifiability( NAggregate, NExpr )
39+ , NonNullifiability
40+ , Nullifiable, nullifiability
41+ , nullifiableOrNot, absurd
42+ , guarder
43+ , nullifier
44+ , unnullifier
45+ )
46+import Rel8.Schema.Dict ( Dict( Dict ) )
47+import Rel8.Schema.HTable ( HTable )
48+import Rel8.Schema.HTable.Nullify
49+ ( HNullify, hnulls, hnullify, hunnullify
50+ , hguard
51+ , hproject
52+ )
53+import qualified Rel8.Schema.Kind as K
54+import Rel8.Schema.Null ( Nullity( NotNull, Null ) )
55+import qualified Rel8.Schema.Result as R
56+import Rel8.Table
57+ ( Table, Columns, Context, toColumns, fromColumns
58+ , FromExprs, fromResult, toResult
59+ , Transpose
60+ )
61+import Rel8.Schema.Spec ( Spec( Spec, nullity ) )
62+import Rel8.Table.Eq ( EqTable, eqTable )
63+import Rel8.Table.Ord ( OrdTable, ordTable )
64+import Rel8.Table.Projection ( Projectable, apply, project )
65+
66+-- semigroupoids
67+import Data.Functor.Apply ( Apply, (<.>), liftF2 )
68+import Data.Functor.Bind ( Bind, (>>-) )
69+import Data.Functor.Extend ( Extend, duplicated )
70+
71+
72+type Nullify :: K.Context -> Type -> Type
73+data Nullify context a
74+ = Table (Nullifiability context) a
75+ | Fields (NonNullifiability context) (HNullify (Columns a) (Context a))
76+
77+
78+instance Projectable (Nullify context) where
79+ project f = \case
80+ Table nullifiable a -> Table nullifiable (fromColumns (apply f (toColumns a)))
81+ Fields nonNullifiable a -> Fields nonNullifiable (hproject (apply f) a)
82+
83+
84+instance Nullifiable context => Functor (Nullify context) where
85+ fmap f = \case
86+ Table nullifiable a -> Table nullifiable (f a)
87+ Fields notNullifiable _ -> absurd nullifiability notNullifiable
88+
89+
90+instance Nullifiable context => Foldable (Nullify context) where
91+ foldMap f = \case
92+ Table _ a -> f a
93+ Fields notNullifiable _ -> absurd nullifiability notNullifiable
94+
95+
96+instance Nullifiable context => Traversable (Nullify context) where
97+ traverse f = \case
98+ Table nullifiable a -> Table nullifiable <$> f a
99+ Fields notNullifiable _ -> absurd nullifiability notNullifiable
100+
101+
102+instance Nullifiable context => Apply (Nullify context) where
103+ liftF2 f = \case
104+ Table nullifiable a -> \case
105+ Table _ b -> Table nullifiable (f a b)
106+ Fields notNullifiable _ -> absurd nullifiable notNullifiable
107+ Fields notNullifiable _ -> absurd nullifiability notNullifiable
108+
109+
110+instance Nullifiable context => Applicative (Nullify context) where
111+ pure = Table nullifiability
112+ liftA2 = liftF2
113+
114+
115+instance Nullifiable context => Bind (Nullify context) where
116+ Table _ a >>- f = f a
117+ Fields notNullifiable _ >>- _ = absurd nullifiability notNullifiable
118+
119+
120+instance Nullifiable context => Monad (Nullify context) where
121+ (>>=) = (>>-)
122+
123+
124+instance Nullifiable context => Extend (Nullify context) where
125+ duplicated = \case
126+ Table nullifiable a -> Table nullifiable (Table nullifiable a)
127+ Fields notNullifiable _ -> absurd nullifiability notNullifiable
128+
129+
130+instance Nullifiable context => Comonad (Nullify context) where
131+ extract = \case
132+ Table _ a -> a
133+ Fields notNullifiable _ -> absurd nullifiability notNullifiable
134+ duplicate = duplicated
135+
136+
137+instance Nullifiable context => ComonadApply (Nullify context) where
138+ (<@>) = (<.>)
139+
140+
141+instance (Table context a, Reifiable context, context ~ context') =>
142+ Table context' (Nullify context a)
143+ where
144+ type Columns (Nullify context a) = HNullify (Columns a)
145+ type Context (Nullify context a) = Context a
146+ type FromExprs (Nullify context a) = Maybe (FromExprs a)
147+ type Transpose to (Nullify context a) = Nullify to (Transpose to a)
148+
149+ fromColumns = case nullifiableOrNot contextSing of
150+ Left notNullifiable -> Fields notNullifiable
151+ Right nullifiable ->
152+ Table nullifiable .
153+ fromColumns .
154+ runIdentity .
155+ hunnullify (\spec -> pure . unnullifier nullifiable spec)
156+
157+ toColumns = \case
158+ Table nullifiable a -> hnullify (nullifier nullifiable) (toColumns a)
159+ Fields _ a -> a
160+
161+ fromResult = fmap (fromResult @_ @a) . hunnullify R.unnullifier
162+
163+ toResult =
164+ maybe (hnulls (const R.null)) (hnullify R.nullifier) .
165+ fmap (toResult @_ @a)
166+
167+
168+instance (EqTable a, context ~ Expr) => EqTable (Nullify context a) where
169+ eqTable = hnullify (\_ Dict -> Dict) (eqTable @a)
170+
171+
172+instance (OrdTable a, context ~ Expr) => OrdTable (Nullify context a) where
173+ ordTable = hnullify (\_ Dict -> Dict) (ordTable @a)
174+
175+
176+aggregateNullify :: ()
177+ => (exprs -> aggregates)
178+ -> Nullify Expr exprs
179+ -> Nullify Aggregate aggregates
180+aggregateNullify f = \case
181+ Table _ a -> Table NAggregate (f a)
182+ Fields notNullifiable _ -> absurd NExpr notNullifiable
183+
184+
185+guard :: (Reifiable context, HTable t)
186+ => context tag
187+ -> (tag -> Bool)
188+ -> (Expr tag -> Expr Bool)
189+ -> HNullify t context
190+ -> HNullify t context
191+guard tag isNonNull isNonNullExpr =
192+ hguard (guarder contextSing tag isNonNull isNonNullExpr)
193+
194+
195+isNull :: forall a. Table Expr a => Nullify Expr a -> Expr Bool
196+isNull =
197+ maybe false getAny .
198+ getConst .
199+ hunnullify (\Spec {nullity} a -> Const $ case nullity of
200+ NotNull -> Just $ Any $ Expr.isNull a
201+ Null -> Nothing) .
202+ toColumns
203+
204+
205+newtype Any = Any
206+ { getAny :: Expr Bool
207+ }
208+
209+
210+instance Semigroup Any where
211+ Any a <> Any b = Any (a ||. b)
src/Rel8/Table/Opaleye.hs+84−75
@@ -1,141 +1,150 @@
1{-# language BlockArguments #-}
1{-# language BlockArguments #-}
2+{-# language DataKinds #-}
2{-# language DisambiguateRecordFields #-}
3{-# language DisambiguateRecordFields #-}
3{-# language FlexibleContexts #-}
4{-# language FlexibleContexts #-}
4{-# language NamedFieldPuns #-}
5{-# language NamedFieldPuns #-}
6+{-# language RankNTypes #-}
5{-# language TypeFamilies #-}
7{-# language TypeFamilies #-}
6{-# language ViewPatterns #-}
8{-# language ViewPatterns #-}
7
9
10+{-# options_ghc -Wno-deprecations #-}
11+
8module Rel8.Table.Opaleye
12module Rel8.Table.Opaleye
9 ( aggregator
13 ( aggregator
14+ , attributes
10 , binaryspec
15 , binaryspec
11 , distinctspec
16 , distinctspec
17+ , exprs
18+ , exprsWithNames
12 , table
19 , table
13 , tableFields
20 , tableFields
14 , unpackspec
21 , unpackspec
15 , valuesspec
22 , valuesspec
23+ , view
16 , castTable
24 , castTable
17 )
25 )
18where
26where
19
27
20-- base
28-- base
21−import Prelude hiding ( undefined )
29+import Data.Functor.Const ( Const( Const ), getConst )
30+import Data.List.NonEmpty ( NonEmpty )
31+import Prelude
22
32
23-- opaleye
33-- opaleye
34+import qualified Opaleye.Adaptors as Opaleye
35+import qualified Opaleye.Field as Opaleye ( Field_ )
24import qualified Opaleye.Internal.Aggregate as Opaleye
36import qualified Opaleye.Internal.Aggregate as Opaleye
25−import qualified Opaleye.Internal.Binary as Opaleye
26−import qualified Opaleye.Internal.Distinct as Opaleye
27import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
37import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
28−import qualified Opaleye.Internal.PackMap as Opaleye
29−import qualified Opaleye.Internal.Unpackspec as Opaleye
30import qualified Opaleye.Internal.Values as Opaleye
38import qualified Opaleye.Internal.Values as Opaleye
31−import qualified Opaleye.Internal.Table as Opaleye
39+import qualified Opaleye.Table as Opaleye
32
40
33-- profunctors
41-- profunctors
34import Data.Profunctor ( dimap, lmap )
42import Data.Profunctor ( dimap, lmap )
35
43
36-- rel8
44-- rel8
37−import Rel8.Aggregate ( Aggregate( Aggregate ) )
45+import Rel8.Aggregate ( Aggregate( Aggregate ), Aggregates )
38−import Rel8.Expr ( Expr, Col(..) )
46+import Rel8.Expr ( Expr )
39import Rel8.Expr.Opaleye
47import Rel8.Expr.Opaleye
40 ( fromPrimExpr, toPrimExpr
48 ( fromPrimExpr, toPrimExpr
41− , traversePrimExpr
49+ , scastExpr, traverseFieldP
42− , fromColumn, toColumn
43− , scastExpr
44 )
50 )
45−import Rel8.Kind.Necessity ( SNecessity( SRequired, SOptional ) )
51+import Rel8.Schema.HTable ( htabulateA, hfield, hspecs, htabulate,
46−import Rel8.Schema.HTable ( htabulateA, hfield, htraverse, hspecs, htabulate )
52+ htraverseP, htraversePWithField )
47−import Rel8.Schema.Insert ( Insert, Inserts, Col(..) )
53+import Rel8.Schema.Name ( Name( Name ), Selects, ppColumn )
48−import Rel8.Schema.Name ( Name, Selects, Col(..) )
54+import Rel8.Schema.Spec ( Spec(..) )
49−import Rel8.Schema.Spec ( SSpec(..) )
55+import Rel8.Schema.Table ( TableSchema(..), ppTable )
50−import Rel8.Schema.Table ( TableSchema(..) )
51import Rel8.Table ( Table, fromColumns, toColumns )
56import Rel8.Table ( Table, fromColumns, toColumns )
52−import Rel8.Table.Undefined ( undefined )
57+import Rel8.Type.Information ( typeName )
53
58
54-- semigroupoids
59-- semigroupoids
55import Data.Functor.Apply ( WrappedApplicative(..) )
60import Data.Functor.Apply ( WrappedApplicative(..) )
61+import Data.Profunctor.Product ( ProductProfunctor )
62+
63+
64+aggregator :: Aggregates aggregates exprs => Opaleye.Aggregator aggregates exprs
65+aggregator = dimap toColumns fromColumns $
66+ htraverseP $
67+ lmap (\(Aggregate a) -> (a, ())) Opaleye.aggregatorApply
56
68
57
69
58−aggregator :: Opaleye.Aggregator (Aggregate exprs) exprs
70+attributes :: Selects names exprs => TableSchema names -> exprs
59−aggregator = Opaleye.Aggregator $ Opaleye.PackMap $
71+attributes schema@TableSchema {columns} = fromColumns $ htabulate $ \field ->
60− \f (Aggregate (Opaleye.Aggregator (Opaleye.PackMap inner))) -> inner f ()
72+ case hfield (toColumns columns) field of
73+ Name column -> fromPrimExpr $ Opaleye.ConstExpr $
74+ Opaleye.OtherLit $
75+ show (ppTable schema) <> "." <> show (ppColumn column)
76+
77+
78+fromOpaleyespec :: (ProductProfunctor p, Table Expr a)
79+ => p (Opaleye.Field_ n x) (Opaleye.Field_ n x)
80+ -> p a a
81+fromOpaleyespec x =
82+ dimap toColumns fromColumns (htraverseP (traverseFieldP x))
61
83
62
84
63binaryspec :: Table Expr a => Opaleye.Binaryspec a a
85binaryspec :: Table Expr a => Opaleye.Binaryspec a a
64−binaryspec = Opaleye.Binaryspec $ Opaleye.PackMap $ \f (as, bs) ->
86+binaryspec = fromOpaleyespec Opaleye.binaryspecField
65− fmap fromColumns $ unwrapApplicative $ htabulateA $ \field ->
66− WrapApplicative $
67− case (hfield (toColumns as) field, hfield (toColumns bs) field) of
68− (DB a, DB b) -> DB . fromPrimExpr <$> f (toPrimExpr a, toPrimExpr b)
69
87
70
88
71distinctspec :: Table Expr a => Opaleye.Distinctspec a a
89distinctspec :: Table Expr a => Opaleye.Distinctspec a a
72−distinctspec =
90+distinctspec = fromOpaleyespec Opaleye.distinctspecField
73− Opaleye.Distinctspec $ Opaleye.Aggregator $ Opaleye.PackMap $ \f ->
91+
74− fmap fromColumns .
92+
75− unwrapApplicative .
93+exprs :: Table Expr a => a -> NonEmpty Opaleye.PrimExpr
76− htraverse
94+exprs (toColumns -> as) = getConst $ htabulateA $ \field ->
77− (\(DB a) ->
95+ case hfield as field of
78− WrapApplicative $ DB . fromPrimExpr <$> f (Nothing, toPrimExpr a)) .
96+ expr -> Const (pure (toPrimExpr expr))
79− toColumns
97+
80−
98+
81−
99+exprsWithNames :: Selects names exprs
82−table ::(Selects names exprs, Inserts exprs inserts)
100+ => names -> exprs -> NonEmpty (String, Opaleye.PrimExpr)
83− => TableSchema names -> Opaleye.Table inserts exprs
101+exprsWithNames names as = getConst $ htabulateA $ \field ->
102+ case (hfield (toColumns names) field, hfield (toColumns as) field) of
103+ (Name name, expr) -> Const (pure (name, toPrimExpr expr))
104+
105+
106+table :: Selects names exprs => TableSchema names -> Opaleye.Table exprs exprs
84table (TableSchema name schema columns) =
107table (TableSchema name schema columns) =
85 case schema of
108 case schema of
86− Nothing -> Opaleye.Table name (tableFields columns)
109+ Nothing -> Opaleye.table name (tableFields columns)
87− Just schemaName -> Opaleye.TableWithSchema schemaName name (tableFields columns)
110+ Just schemaName -> Opaleye.tableWithSchema schemaName name (tableFields columns)
88
111
89
112
90−tableFields :: (Selects names exprs, Inserts exprs inserts)
113+tableFields :: Selects names exprs
91− => names -> Opaleye.TableFields inserts exprs
114+ => names -> Opaleye.TableFields exprs exprs
92tableFields (toColumns -> names) = dimap toColumns fromColumns $
115tableFields (toColumns -> names) = dimap toColumns fromColumns $
93 unwrapApplicative $ htabulateA $ \field -> WrapApplicative $
116 unwrapApplicative $ htabulateA $ \field -> WrapApplicative $
94− case hfield hspecs field of
117+ case hfield names field of
95− specs -> case hfield names field of
118+ name -> lmap (`hfield` field) (go name)
96− name -> lmap (`hfield` field) (go specs name)
97 where
119 where
98− go :: SSpec spec -> Col Name spec -> Opaleye.TableFields (Col Insert spec) (Col Expr spec)
120+ go :: Name a -> Opaleye.TableFields (Expr a) (Expr a)
99− go SSpec {necessity} (NameCol name) = case necessity of
121+ go (Name name) =
100− SRequired ->
122+ traverseFieldP $
101− lmap (\(RequiredInsert a) -> toColumn $ toPrimExpr a) $
123+ Opaleye.requiredTableField name
102− DB . fromPrimExpr . fromColumn <$>
103− Opaleye.requiredTableField name
104− SOptional ->
105− lmap (\(OptionalInsert ma) -> toColumn . toPrimExpr <$> ma) $
106− DB . fromPrimExpr . fromColumn <$>
107− Opaleye.optionalTableField name
108
124
109
125
110unpackspec :: Table Expr a => Opaleye.Unpackspec a a
126unpackspec :: Table Expr a => Opaleye.Unpackspec a a
111−unpackspec = Opaleye.Unpackspec $ Opaleye.PackMap $ \f ->
127+unpackspec = fromOpaleyespec Opaleye.unpackspecField
112− fmap fromColumns .
113− unwrapApplicative .
114− htraverse (\(DB a) -> WrapApplicative $ DB <$> traversePrimExpr f a) .
115− toColumns
116{-# INLINABLE unpackspec #-}
128{-# INLINABLE unpackspec #-}
117
129
118
130
119−valuesspec :: Table Expr a => Opaleye.ValuesspecSafe a a
131+valuesspec :: Table Expr a => Opaleye.Valuesspec a a
120−valuesspec = Opaleye.ValuesspecSafe (toPackMap undefined) unpackspec
132+valuesspec = dimap toColumns fromColumns $
133+ htraversePWithField (traverseFieldP . Opaleye.valuesspecFieldType . typeName)
134+ where typeName = Rel8.Type.Information.typeName . info . hfield hspecs
121
135
122
136
123−toPackMap :: Table Expr a
137+view :: Selects names exprs => names -> exprs
124− => a -> Opaleye.PackMap Opaleye.PrimExpr Opaleye.PrimExpr () a
138+view columns = fromColumns $ htabulate $ \field ->
125−toPackMap as = Opaleye.PackMap $ \f () ->
139+ case hfield (toColumns columns) field of
126− fmap fromColumns $
140+ Name column -> fromPrimExpr $ Opaleye.BaseTableAttrExpr column
127− unwrapApplicative .
128− htraverse (\(DB a) -> WrapApplicative $ DB <$> traversePrimExpr f a) $
129− toColumns as
130
141
131
142
132-- | Transform a table by adding 'CAST' to all columns. This is most useful for
143-- | Transform a table by adding 'CAST' to all columns. This is most useful for
133-- finalising a SELECT or RETURNING statement, guaranteed that the output
144-- finalising a SELECT or RETURNING statement, guaranteed that the output
134-- matches what is encoded in each columns TypeInformation.
145-- matches what is encoded in each columns TypeInformation.
135castTable :: Table Expr a => a -> a
146castTable :: Table Expr a => a -> a
136−castTable (toColumns -> as) = fromColumns $ htabulate \i ->
147+castTable (toColumns -> as) = fromColumns $ htabulate \field ->
137− case hfield hspecs i of
148+ case hfield hspecs field of
138− SSpec{info} ->
149+ Spec {info} -> case hfield as field of
139− case hfield as i of
150+ expr -> scastExpr info expr
140− DB expr ->
141− DB (scastExpr info expr)
src/Rel8/Table/Ord.hs+17−47
@@ -10,7 +10,6 @@
10{-# language TypeFamilies #-}
10{-# language TypeFamilies #-}
11{-# language TypeOperators #-}
11{-# language TypeOperators #-}
12{-# language UndecidableInstances #-}
12{-# language UndecidableInstances #-}
13−{-# language UndecidableSuperClasses #-}
14{-# language ViewPatterns #-}
13{-# language ViewPatterns #-}
15
14
16module Rel8.Table.Ord
15module Rel8.Table.Ord
@@ -21,31 +20,24 @@ where
21-- base
20-- base
22import Data.Functor.Const ( Const( Const ), getConst )
21import Data.Functor.Const ( Const( Const ), getConst )
23import Data.Kind ( Constraint, Type )
22import Data.Kind ( Constraint, Type )
24−import Data.Proxy ( Proxy )
25import GHC.Generics ( Rep )
23import GHC.Generics ( Rep )
26import Prelude hiding ( seq )
24import Prelude hiding ( seq )
27
25
28-- rel8
26-- rel8
29−import Rel8.Expr ( Expr, Col(..) )
27+import Rel8.Expr ( Expr )
30import Rel8.Expr.Bool ( (||.), (&&.), false, true )
28import Rel8.Expr.Bool ( (||.), (&&.), false, true )
31import Rel8.Expr.Eq ( (==.) )
29import Rel8.Expr.Eq ( (==.) )
32import Rel8.Expr.Ord ( (<.), (>.) )
30import Rel8.Expr.Ord ( (<.), (>.) )
33import Rel8.FCF ( Eval, Exp )
31import Rel8.FCF ( Eval, Exp )
34import Rel8.Generic.Record ( Record )
32import Rel8.Generic.Record ( Record )
35−import Rel8.Generic.Table ( GTable, GColumns, gtable )
33+import Rel8.Generic.Table.Record ( GTable, GColumns, gtable )
36import Rel8.Schema.Dict ( Dict( Dict ) )
34import Rel8.Schema.Dict ( Dict( Dict ) )
37−import Rel8.Schema.HTable
35+import Rel8.Schema.HTable ( htabulateA, hfield )
38− ( HTable, HConstrainTable
36+import Rel8.Schema.HTable.Identity ( HIdentity( HIdentity ) )
39− , htabulateA, hfield, hdicts
40− )
41−import Rel8.Schema.HTable.Type ( HType(..) )
42−import Rel8.Schema.Kind ( Context )
43import Rel8.Schema.Null (Sql)
37import Rel8.Schema.Null (Sql)
44−import Rel8.Schema.Spec.ConstrainDBType ( ConstrainDBType )
38+import Rel8.Table ( Columns, toColumns, TColumns )
45−import Rel8.Table ( Table, Columns, toColumns, TColumns )
46import Rel8.Table.Bool ( bool )
39import Rel8.Table.Bool ( bool )
47import Rel8.Table.Eq ( EqTable )
40import Rel8.Table.Eq ( EqTable )
48−import Rel8.Type.Eq ( DBEq )
49import Rel8.Type.Ord ( DBOrd )
41import Rel8.Type.Ord ( DBOrd )
50
42
51
43
@@ -54,46 +46,24 @@ import Rel8.Type.Ord ( DBOrd )
54-- columns in a 'Table' have an instance of 'DBOrd'".
46-- columns in a 'Table' have an instance of 'DBOrd'".
55type OrdTable :: Type -> Constraint
47type OrdTable :: Type -> Constraint
56class EqTable a => OrdTable a where
48class EqTable a => OrdTable a where
57− ordTable :: Columns a (Dict (ConstrainDBType DBOrd))
49+ ordTable :: Columns a (Dict (Sql DBOrd))
58
50
59 default ordTable ::
51 default ordTable ::
60− ( GTable TOrdTable TColumns (Dict (ConstrainDBType DBOrd)) (Rep (Record a))
52+ ( GTable TOrdTable TColumns (Rep (Record a))
61 , Columns a ~ GColumns TColumns (Rep (Record a))
53 , Columns a ~ GColumns TColumns (Rep (Record a))
62 )
54 )
63− => Columns a (Dict (ConstrainDBType DBOrd))
55+ => Columns a (Dict (Sql DBOrd))
64− ordTable = gtable @TOrdTable @TColumns @_ @(Rep (Record a)) table
56+ ordTable = gtable @TOrdTable @TColumns @(Rep (Record a)) table
65 where
57 where
66− table (_ :: Proxy x) = ordTable @x
58+ table (_ :: proxy x) = ordTable @x
67
59
68
60
69data TOrdTable :: Type -> Exp Constraint
61data TOrdTable :: Type -> Exp Constraint
70type instance Eval (TOrdTable a) = OrdTable a
62type instance Eval (TOrdTable a) = OrdTable a
71
63
72
64
73−instance
74− ( Table Expr (t (Expr :: Context))
75− , f ~ Expr
76− , HConstrainTable (Columns (t Expr)) (ConstrainDBType DBEq)
77− , HConstrainTable (Columns (t Expr)) (ConstrainDBType DBOrd)
78− )
79− => OrdTable (t f)
80− where
81− ordTable = hdicts @(Columns (t f)) @(ConstrainDBType DBOrd)
82−
83−
84−instance
85− ( HTable t
86− , f ~ Col Expr
87− , HConstrainTable t (ConstrainDBType DBEq)
88− , HConstrainTable t (ConstrainDBType DBOrd)
89− )
90− => OrdTable (t f)
91− where
92− ordTable = hdicts @(Columns (t f)) @(ConstrainDBType DBOrd)
93−
94−
95instance Sql DBOrd a => OrdTable (Expr a) where
65instance Sql DBOrd a => OrdTable (Expr a) where
96− ordTable = HType Dict
66+ ordTable = HIdentity Dict
97
67
98
68
99instance (OrdTable a, OrdTable b) => OrdTable (a, b)
69instance (OrdTable a, OrdTable b) => OrdTable (a, b)
@@ -128,7 +98,7 @@ instance
128(toColumns -> as) <: (toColumns -> bs) =
98(toColumns -> as) <: (toColumns -> bs) =
129 foldr @[] go false $ getConst $ htabulateA $ \field ->
99 foldr @[] go false $ getConst $ htabulateA $ \field ->
130 case (hfield as field, hfield bs field) of
100 case (hfield as field, hfield bs field) of
131− (DB a, DB b) -> case hfield (ordTable @a) field of
101+ (a, b) -> case hfield (ordTable @a) field of
132 Dict -> Const [(a <. b, a ==. b)]
102 Dict -> Const [(a <. b, a ==. b)]
133 where
103 where
134 go (lt, eq) a = lt ||. (eq &&. a)
104 go (lt, eq) a = lt ||. (eq &&. a)
@@ -141,7 +111,7 @@ infix 4 <:
141(toColumns -> as) <=: (toColumns -> bs) =
111(toColumns -> as) <=: (toColumns -> bs) =
142 foldr @[] go true $ getConst $ htabulateA $ \field ->
112 foldr @[] go true $ getConst $ htabulateA $ \field ->
143 case (hfield as field, hfield bs field) of
113 case (hfield as field, hfield bs field) of
144− (DB a, DB b) -> case hfield (ordTable @a) field of
114+ (a, b) -> case hfield (ordTable @a) field of
145 Dict -> Const [(a <. b, a ==. b)]
115 Dict -> Const [(a <. b, a ==. b)]
146 where
116 where
147 go (lt, eq) a = lt ||. (eq &&. a)
117 go (lt, eq) a = lt ||. (eq &&. a)
@@ -154,7 +124,7 @@ infix 4 <=:
154(toColumns -> as) >: (toColumns -> bs) =
124(toColumns -> as) >: (toColumns -> bs) =
155 foldr @[] go false $ getConst $ htabulateA $ \field ->
125 foldr @[] go false $ getConst $ htabulateA $ \field ->
156 case (hfield as field, hfield bs field) of
126 case (hfield as field, hfield bs field) of
157− (DB a, DB b) -> case hfield (ordTable @a) field of
127+ (a, b) -> case hfield (ordTable @a) field of
158 Dict -> Const [(a >. b, a ==. b)]
128 Dict -> Const [(a >. b, a ==. b)]
159 where
129 where
160 go (gt, eq) a = gt ||. (eq &&. a)
130 go (gt, eq) a = gt ||. (eq &&. a)
@@ -167,7 +137,7 @@ infix 4 >:
167(toColumns -> as) >=: (toColumns -> bs) =
137(toColumns -> as) >=: (toColumns -> bs) =
168 foldr @[] go true $ getConst $ htabulateA $ \field ->
138 foldr @[] go true $ getConst $ htabulateA $ \field ->
169 case (hfield as field, hfield bs field) of
139 case (hfield as field, hfield bs field) of
170− (DB a, DB b) -> case hfield (ordTable @a) field of
140+ (a, b) -> case hfield (ordTable @a) field of
171 Dict -> Const [(a >. b, a ==. b)]
141 Dict -> Const [(a >. b, a ==. b)]
172 where
142 where
173 go (gt, eq) a = gt ||. (eq &&. a)
143 go (gt, eq) a = gt ||. (eq &&. a)
@@ -176,9 +146,9 @@ infix 4 >=:
176
146
177-- | Given two 'Table's, return the table that sorts before the other.
147-- | Given two 'Table's, return the table that sorts before the other.
178least :: OrdTable a => a -> a -> a
148least :: OrdTable a => a -> a -> a
179−least a b = bool a b (a <: b)
149+least a b = bool b a (a <: b)
180
150
181
151
182-- | Given two 'Table's, return the table that sorts after the other.
152-- | Given two 'Table's, return the table that sorts after the other.
183greatest :: OrdTable a => a -> a -> a
153greatest :: OrdTable a => a -> a -> a
184−greatest a b = bool a b (a >: b)
154+greatest a b = bool b a (a >: b)
src/Rel8/Table/Order.hs+13−16
@@ -1,4 +1,5 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2+{-# language NamedFieldPuns #-}
2{-# language ScopedTypeVariables #-}
3{-# language ScopedTypeVariables #-}
3{-# language TypeApplications #-}
4{-# language TypeApplications #-}
4{-# language TypeFamilies #-}
5{-# language TypeFamilies #-}
@@ -15,16 +16,14 @@ import Data.Functor.Contravariant ( (>$<), contramap )
15import Prelude
16import Prelude
16
17
17-- rel8
18-- rel8
18−import Rel8.Expr ( unDB )
19import Rel8.Expr.Order ( asc, desc, nullsFirst, nullsLast )
19import Rel8.Expr.Order ( asc, desc, nullsFirst, nullsLast )
20import Rel8.Order ( Order )
20import Rel8.Order ( Order )
21import Rel8.Schema.Dict ( Dict( Dict ) )
21import Rel8.Schema.Dict ( Dict( Dict ) )
22import Rel8.Schema.HTable (htabulateA, hfield, hspecs)
22import Rel8.Schema.HTable (htabulateA, hfield, hspecs)
23import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
23import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
24−import Rel8.Schema.Spec ( SSpec( SSpec ) )
24+import Rel8.Schema.Spec ( Spec( Spec, nullity ) )
25−import Rel8.Schema.Spec.ConstrainDBType ( dbTypeDict, dbTypeNullity )
26import Rel8.Table ( Columns, toColumns )
25import Rel8.Table ( Columns, toColumns )
27−import Rel8.Table.Ord
26+import Rel8.Table.Ord ( OrdTable, ordTable )
28
27
29
28
30-- | Construct an 'Order' for a 'Table' by sorting all columns into ascending
29-- | Construct an 'Order' for a 'Table' by sorting all columns into ascending
@@ -32,12 +31,11 @@ import Rel8.Table.Ord
32ascTable :: forall a. OrdTable a => Order a
31ascTable :: forall a. OrdTable a => Order a
33ascTable = contramap toColumns $ getConst $
32ascTable = contramap toColumns $ getConst $
34 htabulateA @(Columns a) $ \field -> case hfield hspecs field of
33 htabulateA @(Columns a) $ \field -> case hfield hspecs field of
35− SSpec {} -> case hfield (ordTable @a) field of
34+ Spec {nullity} -> case hfield (ordTable @a) field of
36− dict@Dict -> case dbTypeDict dict of
35+ Dict -> Const $ (`hfield` field) >$<
37− Dict -> Const $ unDB . (`hfield` field) >$<
36+ case nullity of
38− case dbTypeNullity dict of
37+ Null -> nullsFirst asc
39− Null -> nullsFirst asc
38+ NotNull -> asc
40− NotNull -> asc
41
39
42
40
43-- | Construct an 'Order' for a 'Table' by sorting all columns into descending
41-- | Construct an 'Order' for a 'Table' by sorting all columns into descending
@@ -45,9 +43,8 @@ ascTable = contramap toColumns $ getConst $
45descTable :: forall a. OrdTable a => Order a
43descTable :: forall a. OrdTable a => Order a
46descTable = contramap toColumns $ getConst $
44descTable = contramap toColumns $ getConst $
47 htabulateA @(Columns a) $ \field -> case hfield hspecs field of
45 htabulateA @(Columns a) $ \field -> case hfield hspecs field of
48− SSpec {} -> case hfield (ordTable @a) field of
46+ Spec {nullity} -> case hfield (ordTable @a) field of
49− dict@Dict -> case dbTypeDict dict of
47+ Dict -> Const $ (`hfield` field) >$<
50− Dict -> Const $ unDB . (`hfield` field) >$<
48+ case nullity of
51− case dbTypeNullity dict of
49+ Null -> nullsLast desc
52− Null -> nullsLast desc
50+ NotNull -> desc
53− NotNull -> desc
src/Rel8/Table/Projection.hsnew file+73
@@ -0,0 +1,73 @@
1+{-# language FlexibleContexts #-}
2+{-# language FlexibleInstances #-}
3+{-# language MonoLocalBinds #-}
4+{-# language MultiParamTypeClasses #-}
5+{-# language StandaloneKindSignatures #-}
6+{-# language UndecidableInstances #-}
7+
8+module Rel8.Table.Projection
9+ ( Projection
10+ , Projectable( project )
11+ , Biprojectable( biproject )
12+ , Projecting
13+ , apply
14+ )
15+where
16+
17+-- base
18+import Data.Kind ( Constraint, Type )
19+import Prelude
20+
21+-- rel8
22+import Rel8.Schema.Field ( Field( Field ), fields )
23+import Rel8.Schema.HTable ( hfield, htabulate )
24+import Rel8.Table ( Columns, Context, Transpose, toColumns )
25+import Rel8.Table.Transpose ( Transposes )
26+
27+
28+-- | The constraint @'Projecting' a b@ ensures that @'Projection' a b@ is a
29+-- usable 'Projection'.
30+type Projecting :: Type -> Type -> Constraint
31+class
32+ ( Transposes (Context a) (Field a) a (Transpose (Field a) a)
33+ , Transposes (Context a) (Field a) b (Transpose (Field a) b)
34+ )
35+ => Projecting a b
36+instance
37+ ( Transposes (Context a) (Field a) a (Transpose (Field a) a)
38+ , Transposes (Context a) (Field a) b (Transpose (Field a) b)
39+ )
40+ => Projecting a b
41+
42+
43+-- | A @'Projection' a b@s is a special type of function @a -> b@ whereby the
44+-- resulting @b@ is guaranteed to be composed only from columns contained in
45+-- @a@.
46+type Projection :: Type -> Type -> Type
47+type Projection a b = Transpose (Field a) a -> Transpose (Field a) b
48+
49+
50+-- | @'Projectable' f@ means that @f@ is a kind of functor on 'Rel8.Table's
51+-- that allows the mapping of a 'Projection' over its underlying columns.
52+type Projectable :: (Type -> Type) -> Constraint
53+class Projectable f where
54+ -- | Map a 'Projection' over @f@.
55+ project :: Projecting a b
56+ => Projection a b -> f a -> f b
57+
58+
59+-- | @'Biprojectable' p@ means that @p@ is a kind of bifunctor on
60+-- 'Rel8.Table's that allows the mapping of a pair of 'Projection's over its
61+-- underlying columns.
62+type Biprojectable :: (Type -> Type -> Type) -> Constraint
63+class Biprojectable p where
64+ -- | Map a pair of 'Projection's over @p@.
65+ biproject :: (Projecting a b, Projecting c d)
66+ => Projection a b -> Projection c d -> p a c -> p b d
67+
68+
69+apply :: Projecting a b
70+ => Projection a b -> Columns a context -> Columns b context
71+apply f a = case toColumns (f fields) of
72+ bs -> htabulate $ \field -> case hfield bs field of
73+ Field field' -> hfield a field'
src/Rel8/Table/Recontextualize.hsdeleted−90
@@ -1,90 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language FlexibleInstances #-}
3−{-# language FunctionalDependencies #-}
4−{-# language StandaloneKindSignatures #-}
5−{-# language TypeFamilies #-}
6−{-# language UndecidableInstances #-}
7−{-# language UndecidableSuperClasses #-}
8−
9−module Rel8.Table.Recontextualize
10− ( Recontextualize
11− )
12−where
13−
14−-- base
15−import Data.Functor.Identity ( Identity )
16−import Data.Kind ( Constraint, Type )
17−import Prelude ()
18−
19−-- rel8
20−import Rel8.Schema.Context ( Col )
21−import Rel8.Schema.Context.Label ( Labelable )
22−import Rel8.Schema.HTable ( HTable )
23−import qualified Rel8.Schema.Kind as K
24−import Rel8.Schema.Null ( Sql )
25−import Rel8.Schema.Result ( Result )
26−import Rel8.Table ( Table, Congruent )
27−import Rel8.Type ( DBType )
28−
29−
30−type Recontextualize :: K.Context -> K.Context -> Type -> Type -> Constraint
31−class
32− ( Table from a
33− , Table to b
34− , Congruent a b
35− , Recontextualize from from a a
36− , Recontextualize to to b b
37− , Recontextualize to from b a
38− ) => Recontextualize from to a b
39− | a -> from
40− , b -> to
41− , a to -> b
42− , b from -> a
43−
44−
45−instance Sql DBType a => Recontextualize Result Result (Identity a) (Identity a)
46−
47−
48−instance HTable t => Recontextualize from to (t (Col from)) (t (Col to))
49−
50−
51−instance
52− ( Table from (t from)
53− , Table to (t to)
54− , Congruent (t from) (t to)
55− ) => Recontextualize from to (t from) (t to)
56−
57−
58−instance
59− ( Recontextualize from to a1 b1
60− , Recontextualize from to a2 b2
61− , Labelable from
62− , Labelable to
63− ) => Recontextualize from to (a1, a2) (b1, b2)
64−
65−
66−instance
67− ( Recontextualize from to a1 b1
68− , Recontextualize from to a2 b2
69− , Recontextualize from to a3 b3
70− , Labelable from, Labelable to
71− ) => Recontextualize from to (a1, a2, a3) (b1, b2, b3)
72−
73−
74−instance
75− ( Recontextualize from to a1 b1
76− , Recontextualize from to a2 b2
77− , Recontextualize from to a3 b3
78− , Recontextualize from to a4 b4
79− , Labelable from, Labelable to
80− ) => Recontextualize from to (a1, a2, a3, a4) (b1, b2, b3, b4)
81−
82−
83−instance
84− ( Recontextualize from to a1 b1
85− , Recontextualize from to a2 b2
86− , Recontextualize from to a3 b3
87− , Recontextualize from to a4 b4
88− , Recontextualize from to a5 b5
89− , Labelable from, Labelable to
90− ) => Recontextualize from to (a1, a2, a3, a4, a5) (b1, b2, b3, b4, b5)
src/Rel8/Table/Rel8able.hsnew file+92
@@ -0,0 +1,92 @@
1+{-# language DataKinds #-}
2+{-# language FlexibleInstances #-}
3+{-# language MultiParamTypeClasses #-}
4+{-# language ScopedTypeVariables #-}
5+{-# language StandaloneKindSignatures #-}
6+{-# language TypeApplications #-}
7+{-# language TypeFamilies #-}
8+{-# language UndecidableInstances #-}
9+
10+{-# options_ghc -fno-warn-orphans #-}
11+
12+module Rel8.Table.Rel8able
13+ (
14+ )
15+where
16+
17+-- base
18+import Prelude ()
19+
20+-- rel8
21+import Rel8.Expr ( Expr )
22+import qualified Rel8.Kind.Algebra as K
23+import Rel8.Kind.Context ( Reifiable, contextSing )
24+import Rel8.Generic.Rel8able
25+ ( Rel8able, Algebra
26+ , GColumns, gfromColumns, gtoColumns
27+ , GFromExprs, gfromResult, gtoResult
28+ )
29+import qualified Rel8.Schema.Kind as K
30+import Rel8.Schema.HTable ( HConstrainTable, hdicts )
31+import Rel8.Schema.Null ( Sql )
32+import Rel8.Schema.Result ( Result )
33+import Rel8.Table
34+ ( Table, Columns, Context, fromColumns, toColumns
35+ , FromExprs, fromResult, toResult
36+ , Transpose
37+ )
38+import Rel8.Table.ADT ( ADT )
39+import Rel8.Table.Eq ( EqTable, eqTable )
40+import Rel8.Table.Ord ( OrdTable, ordTable )
41+import Rel8.Table.Serialize ( ToExprs )
42+import Rel8.Type.Eq ( DBEq )
43+import Rel8.Type.Ord ( DBOrd )
44+
45+
46+instance (Rel8able t, Reifiable context, context ~ context') =>
47+ Table context' (t context)
48+ where
49+ type Columns (t context) = GColumns t
50+ type Context (t context) = context
51+ type FromExprs (t context) = GFromExprs t
52+ type Transpose to (t context) = t to
53+
54+ fromColumns = gfromColumns contextSing
55+ toColumns = gtoColumns contextSing
56+ fromResult = gfromResult @t
57+ toResult = gtoResult @t
58+
59+
60+instance
61+ ( context ~ Expr
62+ , Rel8able t
63+ , HConstrainTable (Columns (t context)) (Sql DBEq)
64+ )
65+ => EqTable (t context)
66+ where
67+ eqTable = hdicts @(Columns (t context)) @(Sql DBEq)
68+
69+
70+instance
71+ ( context ~ Expr
72+ , Rel8able t
73+ , HConstrainTable (Columns (t context)) (Sql DBEq)
74+ , HConstrainTable (Columns (t context)) (Sql DBOrd)
75+ )
76+ => OrdTable (t context)
77+ where
78+ ordTable = hdicts @(Columns (t context)) @(Sql DBOrd)
79+
80+
81+instance
82+ ( Rel8able t', t' ~ Choose (Algebra t) t
83+ , x ~ t' Expr
84+ , result ~ Result
85+ )
86+ => ToExprs x (t result)
87+
88+
89+type Choose :: K.Algebra -> K.Rel8able -> K.Rel8able
90+type family Choose algebra t where
91+ Choose 'K.Sum t = ADT t
92+ Choose 'K.Product t = t
src/Rel8/Table/Serialize.hs+19−241
@@ -1,7 +1,4 @@
1{-# language AllowAmbiguousTypes #-}
1{-# language AllowAmbiguousTypes #-}
2−{-# language DataKinds #-}
3−{-# language DefaultSignatures #-}
4−{-# language DisambiguateRecordFields #-}
5{-# language FlexibleContexts #-}
2{-# language FlexibleContexts #-}
6{-# language FlexibleInstances #-}
3{-# language FlexibleInstances #-}
7{-# language FunctionalDependencies #-}
4{-# language FunctionalDependencies #-}
@@ -10,178 +7,54 @@
10{-# language StandaloneKindSignatures #-}
7{-# language StandaloneKindSignatures #-}
11{-# language TypeApplications #-}
8{-# language TypeApplications #-}
12{-# language TypeFamilies #-}
9{-# language TypeFamilies #-}
13−{-# language TypeOperators #-}
14{-# language UndecidableInstances #-}
10{-# language UndecidableInstances #-}
15
11
16module Rel8.Table.Serialize
12module Rel8.Table.Serialize
17− ( Serializable, lit, parse
13+ ( Serializable, lit, litHTable, parse
18− , Encodes, litTable
14+ , ToExprs
19− , ToExprs(..)
20− , FromExprs
21 )
15 )
22where
16where
23
17
24-- base
18-- base
25−import Data.Bifunctor ( bimap )
19+import Data.Functor.Identity ( Identity( Identity ) )
26import Data.Kind ( Constraint, Type )
20import Data.Kind ( Constraint, Type )
27import Data.List.NonEmpty ( NonEmpty )
21import Data.List.NonEmpty ( NonEmpty )
28−import GHC.Generics
29− ( Generic, Rep, from, to
30− , (:*:)( (:*:) ), K1( K1 ), M1( M1 ), Meta( MetaSel ), D, C, S
31− )
32−import GHC.TypeLits ( KnownSymbol )
33import Prelude
22import Prelude
34
23
35-- hasql
24-- hasql
36import qualified Hasql.Decoders as Hasql
25import qualified Hasql.Decoders as Hasql
37
26
38-- rel8
27-- rel8
39−import Rel8.Expr ( Expr, Col(..) )
28+import Rel8.Expr ( Expr )
40import Rel8.Expr.Serialize ( slitExpr, sparseValue )
29import Rel8.Expr.Serialize ( slitExpr, sparseValue )
41−import Rel8.Generic.Record ( Record(..) )
42−import Rel8.Generic.Table ( GColumns )
43−import Rel8.Schema.Context ( Col(..) )
44−import Rel8.Schema.Context.Label ( labeler, unlabeler )
45import Rel8.Schema.HTable ( HTable, htabulate, htabulateA, hfield, hspecs )
30import Rel8.Schema.HTable ( HTable, htabulate, htabulateA, hfield, hspecs )
46−import Rel8.Schema.HTable.Label ( HLabel, hlabel, hunlabel )
47−import Rel8.Schema.HTable.Product ( HProduct(..) )
48−import Rel8.Schema.HTable.Type ( HType(..) )
49import Rel8.Schema.Null ( NotNull, Sql )
31import Rel8.Schema.Null ( NotNull, Sql )
50import Rel8.Schema.Result ( Result )
32import Rel8.Schema.Result ( Result )
51−import Rel8.Schema.Spec ( SSpec(..), KnownSpec )
33+import Rel8.Schema.Spec ( Spec(..) )
52−import Rel8.Table ( Table, Columns, fromColumns, toColumns, TColumns )
34+import Rel8.Table ( Table, fromColumns, FromExprs, fromResult, toResult )
53−import Rel8.Table.Either ( EitherTable )
54−import Rel8.Table.List ( ListTable )
55−import Rel8.Table.Maybe ( MaybeTable )
56−import Rel8.Table.NonEmpty ( NonEmptyTable )
57−import Rel8.Table.Recontextualize ( Recontextualize )
58−import Rel8.Table.These ( TheseTable )
59import Rel8.Type ( DBType )
35import Rel8.Type ( DBType )
60
36
61-- semigroupoids
37-- semigroupoids
62import Data.Functor.Apply ( WrappedApplicative(..) )
38import Data.Functor.Apply ( WrappedApplicative(..) )
63
39
64−-- these
65−import Data.These ( These )
66−
67
40
41+-- | @ToExprs exprs a@ is evidence that the types @exprs@ and @a@ describe
42+-- essentially the same type, but @exprs@ is in the 'Expr' context, and @a@ is
43+-- a normal Haskell type.
68type ToExprs :: Type -> Type -> Constraint
44type ToExprs :: Type -> Type -> Constraint
69−class Table Expr exprs => ToExprs exprs a where
45+class Table Expr exprs => ToExprs exprs a
70− fromResult :: Columns exprs (Col Result) -> a
71− toResult :: a -> Columns exprs (Col Result)
72−
73− default fromResult ::
74− ( Generic (Record a)
75− , GToExprs (Rep (Record exprs)) (Rep (Record a))
76− , Columns exprs ~ GColumns TColumns (Rep (Record exprs))
77− )
78− => Columns exprs (Col Result) -> a
79− fromResult = unrecord . to . gfromResult @(Rep (Record exprs))
80−
81− default toResult ::
82− ( Generic (Record a)
83− , GToExprs (Rep (Record exprs)) (Rep (Record a))
84− , Columns exprs ~ GColumns TColumns (Rep (Record exprs))
85− )
86− => a -> Columns exprs (Col Result)
87− toResult = gtoResult @(Rep (Record exprs)) . from . Record
88−
89−
90−type GToExprs :: (Type -> Type) -> (Type -> Type) -> Constraint
91−class GToExprs exprs rep where
92− gfromResult :: GColumns TColumns exprs (Col Result) -> rep x
93− gtoResult :: rep x -> GColumns TColumns exprs (Col Result)
94−
95−
96−instance GToExprs exprs rep => GToExprs (M1 D c exprs) (M1 D c rep) where
97− gfromResult = M1 . gfromResult @exprs
98− gtoResult (M1 a) = gtoResult @exprs a
99
46
100
47
101−instance GToExprs exprs rep => GToExprs (M1 C c exprs) (M1 C c rep) where
48+instance {-# OVERLAPPABLE #-} (Sql DBType a, x ~ Expr a) => ToExprs x a
102− gfromResult = M1 . gfromResult @exprs
103− gtoResult (M1 a) = gtoResult @exprs a
104−
105−
106−instance (GToExprs exprs1 rep1, GToExprs exprs2 rep2) =>
107− GToExprs (exprs1 :*: exprs2) (rep1 :*: rep2)
108− where
109− gfromResult (HProduct a b) = gfromResult @exprs1 a :*: gfromResult @exprs2 b
110− gtoResult (a :*: b) = HProduct (gtoResult @exprs1 a) (gtoResult @exprs2 b)
111−
112−
113−instance
114− ( ToExprs exprs a
115− , KnownSymbol label
116− , GColumns TColumns (M1 S meta k1) ~ HLabel label (Columns exprs)
117− , meta ~ 'MetaSel ('Just label) _su _ss _ds
118− , k1 ~ K1 i exprs
119− , k1' ~ K1 i a
120− )
121− => GToExprs (M1 S meta k1) (M1 S meta k1')
122− where
123− gfromResult = M1 . K1 . fromResult @exprs . hunlabel unlabeler
124− gtoResult (M1 (K1 a)) = hlabel labeler (toResult @exprs a)
125−
126
49
127−instance {-# OVERLAPPABLE #-} (Sql DBType a, x ~ Expr a) => ToExprs x a where
128− fromResult (HType (Result a)) = a
129− toResult = HType . Result
130
50
131−
51+instance (Sql DBType a, x ~ [a]) => ToExprs (Expr x) [a]
132−instance (Sql DBType a, x ~ [a]) => ToExprs (Expr x) [a] where
133− fromResult (HType (Result a)) = a
134− toResult = HType . Result
135
52
136
53
137instance (Sql DBType a, NotNull a, x ~ Maybe a) => ToExprs (Expr x) (Maybe a)
54instance (Sql DBType a, NotNull a, x ~ Maybe a) => ToExprs (Expr x) (Maybe a)
138− where
139− fromResult (HType (Result a)) = a
140− toResult = HType . Result
141
55
142
56
143instance (Sql DBType a, NotNull a, x ~ NonEmpty a) => ToExprs (Expr x) (NonEmpty a)
57instance (Sql DBType a, NotNull a, x ~ NonEmpty a) => ToExprs (Expr x) (NonEmpty a)
144− where
145− fromResult (HType (Result a)) = a
146− toResult = HType . Result
147−
148−
149−instance (ToExprs exprs1 a, ToExprs exprs2 b, x ~ EitherTable exprs1 exprs2) =>
150− ToExprs x (Either a b)
151− where
152− fromResult =
153− bimap (fromResult @exprs1) (fromResult @exprs2) .
154− fromColumns
155− toResult =
156− toColumns .
157− bimap (toResult @exprs1) (toResult @exprs2)
158−
159−
160−instance ToExprs exprs a => ToExprs (ListTable exprs) [a] where
161− fromResult = fmap (fromResult @exprs) . fromColumns
162− toResult = toColumns . fmap (toResult @exprs)
163−
164−
165−instance ToExprs exprs a => ToExprs (MaybeTable exprs) (Maybe a) where
166− fromResult = fmap (fromResult @exprs) . fromColumns
167− toResult = toColumns . fmap (toResult @exprs)
168−
169−
170−instance ToExprs exprs a => ToExprs (NonEmptyTable exprs) (NonEmpty a)
171− where
172− fromResult = fmap (fromResult @exprs) . fromColumns
173− toResult = toColumns . fmap (toResult @exprs)
174−
175−
176−instance (ToExprs exprs1 a, ToExprs exprs2 b, x ~ TheseTable exprs1 exprs2) =>
177− ToExprs x (These a b)
178− where
179− fromResult =
180− bimap (fromResult @exprs1) (fromResult @exprs2) .
181− fromColumns
182− toResult =
183− toColumns .
184− bimap (toResult @exprs1) (toResult @exprs2)
185
58
186
59
187instance (ToExprs exprs1 a, ToExprs exprs2 b, x ~ (exprs1, exprs2)) =>
60instance (ToExprs exprs1 a, ToExprs exprs2 b, x ~ (exprs1, exprs2)) =>
@@ -243,54 +116,6 @@ instance
243 => ToExprs x (a, b, c, d, e, f, g)
116 => ToExprs x (a, b, c, d, e, f, g)
244
117
245
118
246−instance (HTable t, result ~ Col Result, x ~ t (Col Expr)) =>
247− ToExprs x (t result)
248− where
249− fromResult = id
250− toResult = id
251−
252−
253−instance (Recontextualize Result Expr (t Result) (t Expr), result ~ Result, x ~ t Expr) =>
254− ToExprs x (t result)
255− where
256− fromResult = fromColumns
257− toResult = toColumns
258−
259−
260−instance (KnownSpec spec, x ~ Col Expr spec) =>
261− ToExprs x (Col Result spec)
262− where
263− fromResult = fromColumns
264− toResult = toColumns
265−
266−
267−type FromExprs :: Type -> Type
268−type family FromExprs a
269−type instance FromExprs (Expr a) = a
270−type instance FromExprs (Col Expr spec) = Col Result spec
271−type instance FromExprs (EitherTable a b) = Either (FromExprs a) (FromExprs b)
272−type instance FromExprs (ListTable a) = [FromExprs a]
273−type instance FromExprs (MaybeTable a) = Maybe (FromExprs a)
274−type instance FromExprs (NonEmptyTable a) = NonEmpty (FromExprs a)
275−type instance FromExprs (TheseTable a b) = These (FromExprs a) (FromExprs b)
276−type instance FromExprs (a, b) = (FromExprs a, FromExprs b)
277−type instance FromExprs (a, b, c) = (FromExprs a, FromExprs b, FromExprs c)
278−type instance FromExprs (a, b, c, d) =
279− (FromExprs a, FromExprs b, FromExprs c, FromExprs d)
280−type instance FromExprs (a, b, c, d, e) =
281− (FromExprs a, FromExprs b, FromExprs c, FromExprs d, FromExprs e)
282−type instance FromExprs (a, b, c, d, e, f) =
283− ( FromExprs a, FromExprs b, FromExprs c, FromExprs d, FromExprs e
284− , FromExprs f
285− )
286−type instance FromExprs (a, b, c, d, e, f, g) =
287− ( FromExprs a, FromExprs b, FromExprs c, FromExprs d, FromExprs e
288− , FromExprs f, FromExprs g
289− )
290−type instance FromExprs (t Expr) = t Result
291−type instance FromExprs (t (Col Expr)) = t (Col Result)
292−
293−
294-- | @Serializable@ witnesses the one-to-one correspondence between the type
119-- | @Serializable@ witnesses the one-to-one correspondence between the type
295-- @sql@, which contains SQL expressions, and the type @haskell@, which
120-- @sql@, which contains SQL expressions, and the type @haskell@, which
296-- contains the Haskell decoding of rows containing @sql@ SQL expressions.
121-- contains the Haskell decoding of rows containing @sql@ SQL expressions.
@@ -303,68 +128,21 @@ instance {-# OVERLAPPING #-} Sql DBType a => Serializable (Expr a) a
303-- | Use @lit@ to turn literal Haskell values into expressions. @lit@ is
128-- | Use @lit@ to turn literal Haskell values into expressions. @lit@ is
304-- capable of lifting single @Expr@s to full tables.
129-- capable of lifting single @Expr@s to full tables.
305lit :: forall exprs a. Serializable exprs a => a -> exprs
130lit :: forall exprs a. Serializable exprs a => a -> exprs
306−lit = fromColumns . litHTable . toResult @exprs
131+lit = fromColumns . litHTable . toResult @_ @exprs
307
132
308
133
309parse :: forall exprs a. Serializable exprs a => Hasql.Row a
134parse :: forall exprs a. Serializable exprs a => Hasql.Row a
310−parse = fromResult @exprs <$> parseHTable
135+parse = fromResult @_ @exprs <$> parseHTable
311−
312−
313−type Encodes :: Type -> Type -> Constraint
314−class Serializable exprs a => Encodes a exprs | a -> exprs, exprs -> a
315−
316−
317−instance KnownSpec spec => Encodes (Col Result spec) (Col Expr spec)
318−
319−
320−instance Serializable (t Result) (t Expr) => Encodes (t Expr) (t Result)
321−
322−
323−instance HTable t => Encodes (t (Col Result)) (t (Col Expr))
324−
325−
326−instance (Encodes a x, Encodes b y) => Encodes (Either a b) (EitherTable x y)
327−
328−
329−instance Encodes a x => Encodes [a] (ListTable x)
330−
331−
332−instance Encodes a x => Encodes (Maybe a) (MaybeTable x)
333−
334−
335−instance Encodes a x => Encodes (NonEmpty a) (NonEmptyTable x)
336−
337−
338−instance (Encodes a x, Encodes b y) => Encodes (These a b) (TheseTable x y)
339−
340−
341−instance (Encodes a x, Encodes b y) => Encodes (a, b) (x, y)
342−
343−
344−instance (Encodes a x, Encodes b y, Encodes c z) =>
345− Encodes (a, b, c) (x, y, z)
346−
347−
348−instance (Encodes a w, Encodes b x, Encodes c y, Encodes d z) =>
349− Encodes (a, b, c, d) (w, x, y, z)
350−
351−
352−instance (Encodes a v, Encodes b w, Encodes c x, Encodes d y, Encodes e z) =>
353− Encodes (a, b, c, d, e) (v, w, x, y, z)
354−
355−
356−litTable :: Encodes a exprs => a -> exprs
357−litTable = lit
358
136
359
137
360−litHTable :: HTable t => t (Col Result) -> t (Col Expr)
138+litHTable :: HTable t => t Result -> t Expr
361litHTable as = htabulate $ \field ->
139litHTable as = htabulate $ \field ->
362 case hfield hspecs field of
140 case hfield hspecs field of
363− SSpec {nullity, info} -> case hfield as field of
141+ Spec {nullity, info} -> case hfield as field of
364− Result value -> DB (slitExpr nullity info value)
142+ Identity value -> slitExpr nullity info value
365
143
366
144
367−parseHTable :: HTable t => Hasql.Row (t (Col Result))
145+parseHTable :: HTable t => Hasql.Row (t Result)
368parseHTable = unwrapApplicative $ htabulateA $ \field ->
146parseHTable = unwrapApplicative $ htabulateA $ \field ->
369 WrapApplicative $ case hfield hspecs field of
147 WrapApplicative $ case hfield hspecs field of
370− SSpec {nullity, info} -> Result <$> sparseValue nullity info
148+ Spec {nullity, info} -> Identity <$> sparseValue nullity info
src/Rel8/Table/Tag.hsdeleted−97
@@ -1,97 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language FlexibleInstances #-}
3−{-# language GADTs #-}
4−{-# language InstanceSigs #-}
5−{-# language NamedFieldPuns #-}
6−{-# language ScopedTypeVariables #-}
7−{-# language StandaloneKindSignatures #-}
8−{-# language TypeApplications #-}
9−{-# language UndecidableInstances #-}
10−
11−module Rel8.Table.Tag
12− ( Tag(..), Taggable
13− , fromAggregate
14− , fromExpr
15− , fromName
16− )
17−where
18−
19−-- base
20−import Control.Applicative ( (<|>), empty )
21−import Data.Kind ( Constraint, Type )
22−import Data.Foldable ( fold )
23−import Data.Monoid ( getFirst )
24−import Data.Proxy ( Proxy( Proxy ) )
25−import GHC.TypeLits ( KnownSymbol, Symbol, symbolVal )
26−import Prelude
27−
28−-- rel8
29−import Rel8.Aggregate ( Aggregate, Aggregator, foldInputs )
30−import Rel8.Expr ( Expr )
31−import Rel8.Expr.Opaleye ( fromPrimExpr )
32−import Rel8.Schema.Name ( Name( Name ) )
33−import Rel8.Schema.Null ( Sql )
34−import Rel8.Type.Monoid ( DBMonoid )
35−
36−
37−type Tag :: Symbol -> Type -> Type
38−data Tag label a = Tag
39− { expr :: Expr a
40− , aggregator :: Maybe Aggregator
41− , name :: Name a
42− }
43−
44−
45−type Taggable :: Type -> Constraint
46−class Taggable a where
47− tappend :: KnownSymbol label => Tag label a -> Tag label a -> Tag label a
48− tempty :: KnownSymbol label => Tag label a
49−
50−
51−instance Sql DBMonoid a => Taggable a where
52− tappend :: forall label. KnownSymbol label
53− => Tag label a -> Tag label a -> Tag label a
54− tappend a b = Tag
55− { expr = expr a <> expr b
56− , aggregator = aggregator a <|> aggregator b
57− , name = case (name a, symbolVal (Proxy @label)) of
58− (Name x, y)
59− | x == y -> name b
60− | otherwise -> name a
61− }
62− {-# INLINABLE tappend #-}
63−
64− tempty :: forall label. KnownSymbol label => Tag label a
65− tempty = Tag
66− { expr = mempty
67− , aggregator = empty
68− , name = Name (symbolVal (Proxy @label))
69− }
70− {-# INLINABLE tempty #-}
71−
72−
73−instance (KnownSymbol label, Taggable a) => Semigroup (Tag label a) where
74− (<>) = tappend
75−
76−
77−instance (KnownSymbol label, Taggable a) => Monoid (Tag label a) where
78− mempty = tempty
79−
80−
81−fromAggregate :: forall a label. (KnownSymbol label, Taggable a)
82− => Aggregate (Expr a) -> Tag label a
83−fromAggregate = fold . getFirst . foldInputs go
84− where
85− go aggregator primExpr = pure $ (tempty @a @label)
86− { expr = fromPrimExpr primExpr
87− , aggregator
88− }
89−
90−
91−fromExpr :: forall label a. (KnownSymbol label, Taggable a)
92− => Expr a -> Tag label a
93−fromExpr expr = (tempty @a @label) {expr}
94−
95−
96−fromName :: forall a label. Taggable a => Name a -> Tag label a
97−fromName name = (tempty @a @"") {name}
src/Rel8/Table/These.hs+208−143
@@ -5,7 +5,6 @@
5{-# language FlexibleInstances #-}
5{-# language FlexibleInstances #-}
6{-# language MultiParamTypeClasses #-}
6{-# language MultiParamTypeClasses #-}
7{-# language NamedFieldPuns #-}
7{-# language NamedFieldPuns #-}
8−{-# language RecordWildCards #-}
9{-# language ScopedTypeVariables #-}
8{-# language ScopedTypeVariables #-}
10{-# language StandaloneKindSignatures #-}
9{-# language StandaloneKindSignatures #-}
11{-# language TupleSections #-}
10{-# language TupleSections #-}
@@ -13,92 +12,115 @@
13{-# language TypeFamilies #-}
12{-# language TypeFamilies #-}
14{-# language UndecidableInstances #-}
13{-# language UndecidableInstances #-}
15
14
15+{-# options_ghc -fno-warn-orphans #-}
16+
16module Rel8.Table.These
17module Rel8.Table.These
17 ( TheseTable(..)
18 ( TheseTable(..)
18 , theseTable, thisTable, thatTable, thoseTable
19 , theseTable, thisTable, thatTable, thoseTable
19 , isThisTable, isThatTable, isThoseTable
20 , isThisTable, isThatTable, isThoseTable
20 , hasHereTable, hasThereTable
21 , hasHereTable, hasThereTable
21 , justHereTable, justThereTable
22 , justHereTable, justThereTable
22− , aggregateTheseTable, nameTheseTable
23+ , alignMaybeTable
24+ , aggregateTheseTable
25+ , nameTheseTable
23 )
26 )
24where
27where
25
28
26-- base
29-- base
27−import Control.Applicative ( liftA2 )
28import Data.Bifunctor ( Bifunctor, bimap )
30import Data.Bifunctor ( Bifunctor, bimap )
29−import Data.Functor.Identity ( runIdentity )
30import Data.Kind ( Type )
31import Data.Kind ( Type )
31−import Prelude hiding ( undefined )
32+import Data.Maybe ( isJust )
33+import Prelude hiding ( null, undefined )
32
34
33-- rel8
35-- rel8
34import Rel8.Aggregate ( Aggregate )
36import Rel8.Aggregate ( Aggregate )
35import Rel8.Expr ( Expr )
37import Rel8.Expr ( Expr )
36−import Rel8.Expr.Bool ( (&&.), not_ )
38+import Rel8.Expr.Bool ( (&&.), (||.), boolExpr, not_ )
37−import Rel8.Expr.Null ( isNonNull )
39+import Rel8.Expr.Null ( null, isNonNull )
38−import Rel8.Schema.Context.Label
40+import Rel8.Kind.Context ( Reifiable )
39− ( Labelable
41+import Rel8.Schema.Context.Nullify ( Nullifiable )
40− , HLabelable, hlabeler, hunlabeler
42+import Rel8.Schema.Dict ( Dict( Dict ) )
41− )
43+import Rel8.Schema.HTable.Label ( hlabel, hrelabel, hunlabel )
42−import Rel8.Schema.Context.Nullify
43− ( Nullifiable, ConstrainTag
44− , HNullifiable, HConstrainTag
45− , hencodeTag, hdecodeTag
46− , hnullifier, hunnullifier
47− )
48−import Rel8.Schema.HTable ( HTable )
49−import Rel8.Schema.HTable.Label ( hlabel, hunlabel )
50import Rel8.Schema.HTable.Identity ( HIdentity(..) )
44import Rel8.Schema.HTable.Identity ( HIdentity(..) )
51−import Rel8.Schema.HTable.Nullify ( hnullify, hunnullify )
45+import Rel8.Schema.HTable.Maybe ( HMaybeTable(..) )
52import Rel8.Schema.HTable.These ( HTheseTable(..) )
46import Rel8.Schema.HTable.These ( HTheseTable(..) )
47+import qualified Rel8.Schema.Kind as K
53import Rel8.Schema.Name ( Name )
48import Rel8.Schema.Name ( Name )
54import Rel8.Table
49import Rel8.Table
55 ( Table, Columns, Context, fromColumns, toColumns
50 ( Table, Columns, Context, fromColumns, toColumns
56− , reify, unreify
51+ , FromExprs, fromResult, toResult
52+ , Transpose
57 )
53 )
58import Rel8.Table.Eq ( EqTable, eqTable )
54import Rel8.Table.Eq ( EqTable, eqTable )
59import Rel8.Table.Maybe
55import Rel8.Table.Maybe
60 ( MaybeTable(..)
56 ( MaybeTable(..)
61 , maybeTable, justTable, nothingTable
57 , maybeTable, justTable, nothingTable
62 , isJustTable
58 , isJustTable
63− , aggregateMaybeTable, nameMaybeTable
59+ , aggregateMaybeTable
60+ , nameMaybeTable
64 )
61 )
62+import Rel8.Table.Nullify ( Nullify, guard )
65import Rel8.Table.Ord ( OrdTable, ordTable )
63import Rel8.Table.Ord ( OrdTable, ordTable )
66−import Rel8.Table.Recontextualize ( Recontextualize )
64+import Rel8.Table.Projection ( Biprojectable, Projectable, biproject, project )
67−import Rel8.Table.Tag ( Tag(..) )
65+import Rel8.Table.Serialize ( ToExprs )
68import Rel8.Table.Undefined ( undefined )
66import Rel8.Table.Undefined ( undefined )
69import Rel8.Type.Tag ( MaybeTag )
67import Rel8.Type.Tag ( MaybeTag )
70
68
71-- semigroupoids
69-- semigroupoids
72−import Data.Functor.Apply ( Apply, (<.>), liftF2 )
70+import Data.Functor.Apply ( Apply, (<.>) )
73import Data.Functor.Bind ( Bind, (>>-) )
71import Data.Functor.Bind ( Bind, (>>-) )
74
72
75−
73+-- these
76−type TheseTable :: Type -> Type -> Type
74+import Data.These ( These( This, That, These ) )
77−data TheseTable a b = TheseTable
75+import Data.These.Combinators ( justHere, justThere )
78− { here :: MaybeTable a
76+
79− , there :: MaybeTable b
77+
78+-- | @TheseTable a b@ is a Rel8 table that contains either the table @a@, the
79+-- table @b@, or both tables @a@ and @b@. You can construct @TheseTable@s using
80+-- 'thisTable', 'thatTable' and 'thoseTable'. @TheseTable@s can be
81+-- eliminated/pattern matched using 'theseTable'.
82+--
83+-- @TheseTable@ is operationally the same as Haskell's 'These' type, but
84+-- adapted to work with Rel8.
85+type TheseTable :: K.Context -> Type -> Type -> Type
86+data TheseTable context a b = TheseTable
87+ { here :: MaybeTable context a
88+ , there :: MaybeTable context b
80 }
89 }
81 deriving stock Functor
90 deriving stock Functor
82
91
83
92
84−instance Bifunctor TheseTable where
93+instance Biprojectable (TheseTable context) where
94+ biproject f g (TheseTable a b) = TheseTable (project f a) (project g b)
95+
96+
97+instance Nullifiable context => Bifunctor (TheseTable context) where
85 bimap f g (TheseTable a b) = TheseTable (fmap f a) (fmap g b)
98 bimap f g (TheseTable a b) = TheseTable (fmap f a) (fmap g b)
86
99
87
100
88−instance (Table Expr a, Semigroup a) => Apply (TheseTable a) where
101+instance Projectable (TheseTable context a) where
102+ project f (TheseTable a b) = TheseTable a (project f b)
103+
104+
105+instance (context ~ Expr, Table Expr a, Semigroup a) =>
106+ Apply (TheseTable context a)
107+ where
89 fs <.> as = TheseTable
108 fs <.> as = TheseTable
90 { here = here fs <> here as
109 { here = here fs <> here as
91 , there = there fs <.> there as
110 , there = there fs <.> there as
92 }
111 }
93
112
94
113
95−instance (Table Expr a, Semigroup a) => Applicative (TheseTable a)
114+instance (context ~ Expr, Table Expr a, Semigroup a) =>
115+ Applicative (TheseTable context a)
96 where
116 where
97 pure = thatTable
117 pure = thatTable
98 (<*>) = (<.>)
118 (<*>) = (<.>)
99
119
100
120
101−instance (Table Expr a, Semigroup a) => Bind (TheseTable a) where
121+instance (context ~ Expr, Table Expr a, Semigroup a) =>
122+ Bind (TheseTable context a)
123+ where
102 TheseTable here1 ma >>- f = case ma >>- f' of
124 TheseTable here1 ma >>- f = case ma >>- f' of
103 mtb -> TheseTable
125 mtb -> TheseTable
104 { here = maybeTable here1 ((here1 <>) . fst) mtb
126 { here = maybeTable here1 ((here1 <>) . fst) mtb
@@ -109,12 +131,14 @@ instance (Table Expr a, Semigroup a) => Bind (TheseTable a) where
109 TheseTable here2 mb -> (here2,) <$> mb
131 TheseTable here2 mb -> (here2,) <$> mb
110
132
111
133
112−instance (Table Expr a, Semigroup a) => Monad (TheseTable a) where
134+instance (context ~ Expr, Table Expr a, Semigroup a) =>
135+ Monad (TheseTable context a)
136+ where
113 (>>=) = (>>-)
137 (>>=) = (>>-)
114
138
115
139
116−instance (Table Expr a, Table Expr b, Semigroup a, Semigroup b) =>
140+instance (context ~ Expr, Table Expr a, Table Expr b, Semigroup a, Semigroup b) =>
117− Semigroup (TheseTable a b)
141+ Semigroup (TheseTable context a b)
118 where
142 where
119 a <> b = TheseTable
143 a <> b = TheseTable
120 { here = here a <> here b
144 { here = here a <> here b
@@ -124,85 +148,175 @@ instance (Table Expr a, Table Expr b, Semigroup a, Semigroup b) =>
124
148
125instance
149instance
126 ( Table context a, Table context b
150 ( Table context a, Table context b
127− , Labelable context, Nullifiable context, ConstrainTag context MaybeTag
151+ , Reifiable context, context ~ context'
128− ) => Table context (TheseTable a b)
152+ )
153+ => Table context' (TheseTable context a b)
129 where
154 where
130− type Columns (TheseTable a b) = HTheseTable (Columns a) (Columns b)
155+ type Columns (TheseTable context a b) = HTheseTable (Columns a) (Columns b)
131− type Context (TheseTable a b) = Context a
156+ type Context (TheseTable context a b) = Context a
132−
157+ type FromExprs (TheseTable context a b) =
133− toColumns = toColumns2 toColumns toColumns
158+ These (FromExprs a) (FromExprs b)
134− fromColumns = fromColumns2 fromColumns fromColumns
159+ type Transpose to (TheseTable context a b) =
135− reify = liftA2 bimap reify reify
160+ TheseTable to (Transpose to a) (Transpose to b)
136− unreify = liftA2 bimap unreify unreify
161+
137−
162+ toColumns TheseTable {here, there} = HTheseTable
138−
163+ { hhereTag = hlabel $ HIdentity $ tag here
139−instance
164+ , hhere =
140− ( Labelable from, Nullifiable from, ConstrainTag from MaybeTag
165+ hlabel $ guard (tag here) isJust isNonNull $ toColumns $ just here
141− , Labelable to, Nullifiable to, ConstrainTag to MaybeTag
166+ , hthereTag = hlabel $ HIdentity $ tag there
142− , Recontextualize from to a1 b1
167+ , hthere =
143− , Recontextualize from to a2 b2
168+ hlabel $ guard (tag there) isJust isNonNull $ toColumns $ just there
144− ) =>
169+ }
145− Recontextualize from to (TheseTable a1 a2) (TheseTable b1 b2)
146−
147−
148−instance (EqTable a, EqTable b) => EqTable (TheseTable a b) where
149− eqTable = toColumns2 id id (thoseTable (eqTable @a) (eqTable @b))
150
170
171+ fromColumns HTheseTable {hhereTag, hhere, hthereTag, hthere} = TheseTable
172+ { here = MaybeTable
173+ { tag = unHIdentity $ hunlabel hhereTag
174+ , just = fromColumns $ hunlabel hhere
175+ }
176+ , there = MaybeTable
177+ { tag = unHIdentity $ hunlabel hthereTag
178+ , just = fromColumns $ hunlabel hthere
179+ }
180+ }
151
181
152−instance (OrdTable a, OrdTable b) => OrdTable (TheseTable a b) where
182+ toResult tables = HTheseTable
153− ordTable = toColumns2 id id (thoseTable (ordTable @a) (ordTable @b))
183+ { hhereTag = hrelabel hhereTag
184+ , hhere = hrelabel hhere
185+ , hthereTag = hrelabel hthereTag
186+ , hthere = hrelabel hthere
187+ }
188+ where
189+ HMaybeTable
190+ { htag = hhereTag
191+ , hjust = hhere
192+ } = toResult @_ @(MaybeTable context a) (justHere tables)
193+ HMaybeTable
194+ { htag = hthereTag
195+ , hjust = hthere
196+ } = toResult @_ @(MaybeTable context b) (justThere tables)
197+
198+ fromResult HTheseTable {hhereTag, hhere, hthereTag, hthere} =
199+ case (here, there) of
200+ (Just a, Nothing) -> This a
201+ (Nothing, Just b) -> That b
202+ (Just a, Just b) -> These a b
203+ _ -> error "These.fromColumns: mismatch between tags and data"
204+ where
205+ here = fromResult @_ @(MaybeTable context a) mhere
206+ there = fromResult @_ @(MaybeTable context b) mthere
207+ mhere = HMaybeTable
208+ { htag = hrelabel hhereTag
209+ , hjust = hrelabel hhere
210+ }
211+ mthere = HMaybeTable
212+ { htag = hrelabel hthereTag
213+ , hjust = hrelabel hthere
214+ }
215+
216+
217+instance (EqTable a, EqTable b, context ~ Expr) =>
218+ EqTable (TheseTable context a b)
219+ where
220+ eqTable = HTheseTable
221+ { hhereTag = hlabel (HIdentity Dict)
222+ , hhere = hlabel (eqTable @(Nullify context a))
223+ , hthereTag = hlabel (HIdentity Dict)
224+ , hthere = hlabel (eqTable @(Nullify context b))
225+ }
154
226
155
227
156−toHereTag :: Tag "isJust" a -> Tag "hasHere" a
228+instance (OrdTable a, OrdTable b, context ~ Expr) =>
157−toHereTag Tag {..} = Tag {..}
229+ OrdTable (TheseTable context a b)
230+ where
231+ ordTable = HTheseTable
232+ { hhereTag = hlabel (HIdentity Dict)
233+ , hhere = hlabel (ordTable @(Nullify context a))
234+ , hthereTag = hlabel (HIdentity Dict)
235+ , hthere = hlabel (ordTable @(Nullify context b))
236+ }
158
237
159
238
160−toThereTag :: Tag "isJust" a -> Tag "hasThere" a
239+instance (ToExprs exprs1 a, ToExprs exprs2 b, x ~ TheseTable Expr exprs1 exprs2) =>
161−toThereTag Tag {..} = Tag {..}
240+ ToExprs x (These a b)
162
241
163
242
164−isThisTable :: TheseTable a b -> Expr Bool
243+-- | Test if a 'TheseTable' was constructed with 'thisTable'.
244+--
245+-- Corresponds to 'Data.These.Combinators.isThis'.
246+isThisTable :: TheseTable Expr a b -> Expr Bool
165isThisTable a = hasHereTable a &&. not_ (hasThereTable a)
247isThisTable a = hasHereTable a &&. not_ (hasThereTable a)
166
248
167
249
168−isThatTable :: TheseTable a b -> Expr Bool
250+-- | Test if a 'TheseTable' was constructed with 'thatTable'.
251+--
252+-- Corresponds to 'Data.These.Combinators.isThat'.
253+isThatTable :: TheseTable Expr a b -> Expr Bool
169isThatTable a = not_ (hasHereTable a) &&. hasThereTable a
254isThatTable a = not_ (hasHereTable a) &&. hasThereTable a
170
255
171
256
172−isThoseTable :: TheseTable a b -> Expr Bool
257+-- | Test if a 'TheseTable' was constructed with 'thoseTable'.
258+--
259+-- Corresponds to 'Data.These.Combinators.isThese'.
260+isThoseTable :: TheseTable Expr a b -> Expr Bool
173isThoseTable a = hasHereTable a &&. hasThereTable a
261isThoseTable a = hasHereTable a &&. hasThereTable a
174
262
175
263
176−hasHereTable :: TheseTable a b -> Expr Bool
264+-- | Test if the @a@ side of @TheseTable a b@ is present.
265+--
266+-- Corresponds to 'Data.These.Combinators.hasHere'.
267+hasHereTable :: TheseTable Expr a b -> Expr Bool
177hasHereTable TheseTable {here} = isJustTable here
268hasHereTable TheseTable {here} = isJustTable here
178
269
179
270
180−hasThereTable :: TheseTable a b -> Expr Bool
271+-- | Test if the @b@ table of @TheseTable a b@ is present.
272+--
273+-- Corresponds to 'Data.These.Combinators.hasThere'.
274+hasThereTable :: TheseTable Expr a b -> Expr Bool
181hasThereTable TheseTable {there} = isJustTable there
275hasThereTable TheseTable {there} = isJustTable there
182
276
183
277
184−justHereTable :: TheseTable a b -> MaybeTable a
278+-- | Attempt to project out the @a@ table of a @TheseTable a b@.
279+--
280+-- Corresponds to 'Data.These.Combinators.justHere'.
281+justHereTable :: TheseTable context a b -> MaybeTable context a
185justHereTable = here
282justHereTable = here
186
283
187
284
188−justThereTable :: TheseTable a b -> MaybeTable b
285+-- | Attempt to project out the @b@ table of a @TheseTable a b@.
286+--
287+-- Corresponds to 'Data.These.Combinators.justThere'.
288+justThereTable :: TheseTable context a b -> MaybeTable context b
189justThereTable = there
289justThereTable = there
190
290
191
291
192−thisTable :: Table Expr b => a -> TheseTable a b
292+-- | Construct a @TheseTable@ from two 'MaybeTable's.
293+alignMaybeTable :: ()
294+ => MaybeTable Expr a
295+ -> MaybeTable Expr b
296+ -> MaybeTable Expr (TheseTable Expr a b)
297+alignMaybeTable a b = MaybeTable tag (pure (TheseTable a b))
298+ where
299+ tag = boolExpr null mempty (isJustTable a ||. isJustTable b)
300+
301+
302+-- | Construct a @TheseTable@. Corresponds to 'This'.
303+thisTable :: Table Expr b => a -> TheseTable Expr a b
193thisTable a = TheseTable (justTable a) nothingTable
304thisTable a = TheseTable (justTable a) nothingTable
194
305
195
306
196−thatTable :: Table Expr a => b -> TheseTable a b
307+-- | Construct a @TheseTable@. Corresponds to 'That'.
308+thatTable :: Table Expr a => b -> TheseTable Expr a b
197thatTable b = TheseTable nothingTable (justTable b)
309thatTable b = TheseTable nothingTable (justTable b)
198
310
199
311
200−thoseTable :: a -> b -> TheseTable a b
312+-- | Construct a @TheseTable@. Corresponds to 'These'.
313+thoseTable :: a -> b -> TheseTable Expr a b
201thoseTable a b = TheseTable (justTable a) (justTable b)
314thoseTable a b = TheseTable (justTable a) (justTable b)
202
315
203
316
317+-- | Pattern match on a 'TheseTable'. Corresponds to 'these'.
204theseTable :: Table Expr c
318theseTable :: Table Expr c
205− => (a -> c) -> (b -> c) -> (a -> b -> c) -> TheseTable a b -> c
319+ => (a -> c) -> (b -> c) -> (a -> b -> c) -> TheseTable Expr a b -> c
206theseTable f g h TheseTable {here, there} =
320theseTable f g h TheseTable {here, there} =
207 maybeTable
321 maybeTable
208 (maybeTable undefined f here)
322 (maybeTable undefined f here)
@@ -210,83 +324,34 @@ theseTable f g h TheseTable {here, there} =
210 there
324 there
211
325
212
326
327+-- | Lift a pair of aggregating functions to operate on an 'TheseTable'.
328+-- @thisTable@s, @thatTable@s and @thoseTable@s are grouped separately.
213aggregateTheseTable :: ()
329aggregateTheseTable :: ()
214− => (a -> Aggregate c)
330+ => (exprs -> aggregates)
215− -> (b -> Aggregate d)
331+ -> (exprs' -> aggregates')
216− -> TheseTable a b
332+ -> TheseTable Expr exprs exprs'
217− -> Aggregate (TheseTable c d)
333+ -> TheseTable Aggregate aggregates aggregates'
218−aggregateTheseTable f g TheseTable {here, there} =
334+aggregateTheseTable f g (TheseTable here there) = TheseTable
219− liftF2 TheseTable (aggregateMaybeTable f here) (aggregateMaybeTable g there)
335+ { here = aggregateMaybeTable f here
336+ , there = aggregateMaybeTable g there
337+ }
220
338
221
339
340+-- | Construct a 'TheseTable' in the 'Name' context. This can be useful if you
341+-- have a 'TheseTable' that you are storing in a table and need to construct a
342+-- 'TableSchema'.
222nameTheseTable :: ()
343nameTheseTable :: ()
223 => Name (Maybe MaybeTag)
344 => Name (Maybe MaybeTag)
345+ -- ^ The name of the column to track the presence of the @a@ table.
224 -> Name (Maybe MaybeTag)
346 -> Name (Maybe MaybeTag)
347+ -- ^ The name of the column to track the presence of the @b@ table.
225 -> a
348 -> a
349+ -- ^ Names of the columns in the @a@ table.
226 -> b
350 -> b
227− -> TheseTable a b
351+ -- ^ Names of the columns in the @b@ table.
352+ -> TheseTable Name a b
228nameTheseTable here there a b =
353nameTheseTable here there a b =
229 TheseTable
354 TheseTable
230 { here = nameMaybeTable here a
355 { here = nameMaybeTable here a
231 , there = nameMaybeTable there b
356 , there = nameMaybeTable there b
232 }
357 }
233−
234−
235−toColumns2 ::
236− ( HTable t
237− , HTable u
238− , HConstrainTag context MaybeTag
239− , HLabelable context
240− , HNullifiable context
241− )
242− => (a -> t context)
243− -> (b -> u context)
244− -> TheseTable a b
245− -> HTheseTable t u context
246−toColumns2 f g TheseTable {here, there} = HTheseTable
247− { hhereTag = HIdentity $ hencodeTag (toHereTag (tag here))
248− , hhere =
249− hlabel hlabeler $ hnullify (hnullifier (tag here) isNonNull) $ f (just here)
250− , hthereTag = HIdentity $ hencodeTag (toThereTag (tag there))
251− , hthere =
252− hlabel hlabeler $ hnullify (hnullifier (tag there) isNonNull) $ g (just there)
253− }
254−
255−
256−fromColumns2 ::
257− ( HTable t
258− , HTable u
259− , HConstrainTag context MaybeTag
260− , HLabelable context
261− , HNullifiable context
262− )
263− => (t context -> a)
264− -> (u context -> b)
265− -> HTheseTable t u context
266− -> TheseTable a b
267−fromColumns2 f g HTheseTable {hhereTag, hhere, hthereTag, hthere} = TheseTable
268− { here =
269− let
270− tag = hdecodeTag $ unHIdentity hhereTag
271− in
272− MaybeTable
273− { tag
274− , just = f $
275− runIdentity $
276− hunnullify (\a -> pure . hunnullifier a) $
277− hunlabel hunlabeler
278− hhere
279− }
280− , there =
281− let
282− tag = hdecodeTag $ unHIdentity hthereTag
283− in
284− MaybeTable
285− { tag
286− , just = g $
287− runIdentity $
288− hunnullify (\a -> pure . hunnullifier a) $
289− hunlabel hunlabeler
290− hthere
291− }
292− }
src/Rel8/Table/Transpose.hsnew file+46
@@ -0,0 +1,46 @@
1+{-# language DataKinds #-}
2+{-# language FlexibleInstances #-}
3+{-# language FunctionalDependencies #-}
4+{-# language StandaloneKindSignatures #-}
5+{-# language TypeFamilies #-}
6+{-# language UndecidableInstances #-}
7+
8+module Rel8.Table.Transpose
9+ ( Transposes
10+ )
11+where
12+
13+-- base
14+import Data.Kind ( Constraint, Type )
15+import Prelude ()
16+
17+-- rel8
18+import qualified Rel8.Schema.Kind as K
19+import Rel8.Table ( Table, Transpose, Congruent )
20+
21+
22+-- | @'Transposes' from to a b@ means that @a@ and @b@ are 'Table's, in the
23+-- @from@ and @to@ contexts respectively, which share the same underlying
24+-- structure. In other words, @b@ is a version of @a@ transposed from the
25+-- @from@ context to the @to@ context (and vice versa).
26+type Transposes :: K.Context -> K.Context -> Type -> Type -> Constraint
27+class
28+ ( Table from a
29+ , Table to b
30+ , Congruent a b
31+ , b ~ Transpose to a
32+ , a ~ Transpose from b
33+ )
34+ => Transposes from to a b
35+ | a -> from
36+ , b -> to
37+ , a to -> b
38+ , b from -> a
39+instance
40+ ( Table from a
41+ , Table to b
42+ , Congruent a b
43+ , b ~ Transpose to a
44+ , a ~ Transpose from b
45+ )
46+ => Transposes from to a b
src/Rel8/Table/Undefined.hs+5−5
@@ -11,16 +11,16 @@ where
11import Prelude hiding ( undefined )
11import Prelude hiding ( undefined )
12
12
13-- rel8
13-- rel8
14−import Rel8.Expr ( Expr, Col(..) )
14+import Rel8.Expr ( Expr )
15import Rel8.Expr.Null ( snull, unsafeUnnullify )
15import Rel8.Expr.Null ( snull, unsafeUnnullify )
16import Rel8.Schema.HTable ( htabulate, hfield, hspecs )
16import Rel8.Schema.HTable ( htabulate, hfield, hspecs )
17import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
17import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
18−import Rel8.Schema.Spec ( SSpec(..) )
18+import Rel8.Schema.Spec ( Spec(..) )
19import Rel8.Table ( Table, fromColumns )
19import Rel8.Table ( Table, fromColumns )
20
20
21
21
22undefined :: Table Expr a => a
22undefined :: Table Expr a => a
23undefined = fromColumns $ htabulate $ \field -> case hfield hspecs field of
23undefined = fromColumns $ htabulate $ \field -> case hfield hspecs field of
24− SSpec {nullity, info} -> case nullity of
24+ Spec {nullity, info} -> case nullity of
25− Null -> DB (snull info)
25+ Null -> snull info
26− NotNull -> DB (unsafeUnnullify (snull info))
26+ NotNull -> unsafeUnnullify (snull info)
src/Rel8/Table/Unreify.hsdeleted−43
@@ -1,43 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language StandaloneKindSignatures #-}
3−{-# language TypeFamilies #-}
4−{-# language UndecidableInstances #-}
5−
6−-- | This module implements some machinery for implementing methods of the
7−-- 'Table' class for a particular special (but important) class of polymorphic
8−-- @Table@ types.
9−--
10−-- This special case is characterised by a @newtype@ wrapper around a bare
11−-- 'HTable' which is constructed by applying a type family to the polymorphic
12−-- type variable.
13−--
14−-- Examples of this class of @Table@ include @ListTable@ and @NonEmptyTable@.
15−--
16−-- The tricky part about implementing @Table@ for these types is 'reify' and
17−-- 'unreify'. There is no guarantee in general that @'Unreify' a@ is itself
18−-- a @Table@, let alone a @Table@ with the same 'Columns' as @a@
19−-- (e.g., @Unreify (AColumn Result Bool) = Bool@, and @Bool@ is not a
20−-- @Table@)
21−
22−module Rel8.Table.Unreify
23− ( Unreifiable
24− )
25−where
26−
27−-- base
28−import Data.Kind ( Constraint, Type )
29−import Prelude ()
30−
31−-- rel8
32−import qualified Rel8.Schema.Kind as K
33−import Rel8.Schema.Reify ( Reify )
34−import Rel8.Table ( Table, Columns, Unreify )
35−
36−
37−type Unreifiable :: K.Context -> Type -> Constraint
38−type family Unreifiable context a where
39− Unreifiable (Reify context) a =
40− ( Table context (Unreify a)
41− , Columns a ~ Columns (Unreify a)
42− )
43− Unreifiable _ _ = ()
src/Rel8/Table/Window.hsnew file+43
@@ -0,0 +1,43 @@
1+{-# language MonoLocalBinds #-}
2+
3+module Rel8.Table.Window
4+ ( cumulative
5+ , cumulative_
6+ , currentRow
7+ )
8+where
9+
10+-- base
11+import Prelude
12+
13+-- opaleye
14+import qualified Opaleye.Window as Opaleye
15+
16+-- rel8
17+import Rel8.Aggregate ( Aggregates )
18+import qualified Rel8.Expr.Window as Expr
19+import Rel8.Schema.HTable ( hfield, htabulateA )
20+import Rel8.Table ( fromColumns, toColumns )
21+import Rel8.Window ( Window( Window ) )
22+
23+
24+-- | 'cumulative' allows the use of aggregation functions in 'Window'
25+-- expressions. In particular, @'cumulative' 'Rel8.sum'@
26+-- (when combined with 'Rel8.Window.orderPartitionBy') gives a running total,
27+-- also known as a \"cumulative sum\", hence the name @cumulative@.
28+cumulative :: Aggregates aggregates exprs => (a -> aggregates) -> Window a exprs
29+cumulative f =
30+ fmap fromColumns $
31+ htabulateA $ \field ->
32+ Expr.cumulative ((`hfield` field) . toColumns . f)
33+
34+
35+-- | A version of 'cumulative' for use with nullary aggregators like
36+-- 'Rel8.Expr.Aggregate.countStar'.
37+cumulative_ :: Aggregates aggregates exprs => aggregates -> Window a exprs
38+cumulative_ = cumulative . const
39+
40+
41+-- | Return every column of the current row of a window query.
42+currentRow :: Window a a
43+currentRow = Window $ Opaleye.over (Opaleye.noWindowFunction id) mempty mempty
src/Rel8/Tabulate.hs+530−228
@@ -1,338 +1,640 @@
1−{-# language DeriveFunctor #-}
2−{-# language DerivingStrategies #-}
3{-# language FlexibleContexts #-}
1{-# language FlexibleContexts #-}
2+{-# language MonoLocalBinds #-}
3+{-# language ScopedTypeVariables #-}
4+{-# language StandaloneKindSignatures #-}
5+{-# language TypeApplications #-}
4{-# language TupleSections #-}
6{-# language TupleSections #-}
7+{-# language UndecidableInstances #-}
8+
9+-- | "Rel8.Tabulate" provides an alternative API ('Tabulation') for writing
10+-- queries that complements the main "Rel8" API ('Query').
5
11
6module Rel8.Tabulate
12module Rel8.Tabulate
7− ( Tabulation
13+ (
8− , runTabulation
14+ Tabulation
9− , tabulate
15+
10− , tabulateA
16+ -- * Interfacing with 'Query's
11 , fromQuery
17 , fromQuery
18+ , toQuery
12 , liftQuery
19 , liftQuery
13− , prebind
20+ , through
14− , postbind
15− , indexed
16− , ifilter
17 , lookup
21 , lookup
22+
23+ -- * Aggregation and Ordering
24+ , aggregate
25+ , distinct
26+ , order
27+
28+ -- ** Magic 'Tabulation's
29+ -- $magic
30+ , count
31+ , optional
32+ , many
33+ , some
34+ , exists
35+ , present
36+ , absent
37+
38+ -- * Natural joins
18 , align
39 , align
19 , alignWith
40 , alignWith
20 , leftAlign
41 , leftAlign
21 , leftAlignWith
42 , leftAlignWith
43+ , rightAlign
44+ , rightAlignWith
22 , zip
45 , zip
23 , zipWith
46 , zipWith
24 , similarity
47 , similarity
25 , difference
48 , difference
26− , aggregateTabulation
27− , optionalTabulation
28 )
49 )
29where
50where
30
51
31-- base
52-- base
32−import Control.Applicative ( liftA2 )
53+import Control.Applicative ( (<|>), empty, liftA2 )
33−import Control.Monad ( join, liftM2 )
54+import Control.Monad ( liftM2 )
34−import Data.Bifunctor ( bimap, first )
55+import Data.Bifunctor ( Bifunctor, bimap, first, second )
35import Data.Foldable ( traverse_ )
56import Data.Foldable ( traverse_ )
36−import Data.Maybe ( fromMaybe )
57+import Data.Function ( on )
37−import Prelude hiding ( filter, lookup, undefined, zip, zipWith )
58+import Data.Functor.Contravariant ( Contravariant, (>$<), contramap )
59+import Data.Int ( Int64 )
60+import Data.Kind ( Type )
61+import Data.Maybe ( fromJust, fromMaybe )
62+import Prelude hiding ( lookup, zip, zipWith )
63+
64+-- bifunctors
65+import Data.Bifunctor.Clown ( Clown( Clown ), runClown )
66+
67+-- comonad
68+import Control.Comonad ( extract )
69+
70+-- opaleye
71+import qualified Opaleye.Aggregate as Opaleye
72+import qualified Opaleye.Order as Opaleye ( orderBy, distinctOnExplicit )
73+
74+-- profunctors
75+import Data.Profunctor ( dimap, lmap )
76+
77+-- product-profunctors
78+import Data.Profunctor.Product
79+ ( ProductProfunctor, (***!)
80+ , SumProfunctor, (+++!)
81+ )
82+import qualified Data.Profunctor.Product as PP
38
83
39-- rel8
84-- rel8
40−import Rel8.Aggregate ( Aggregate )
85+import Rel8.Aggregate ( Aggregates )
41import Rel8.Expr ( Expr )
86import Rel8.Expr ( Expr )
42−import Rel8.Expr.Bool ( not_, true )
87+import Rel8.Expr.Aggregate ( countStar )
88+import Rel8.Expr.Bool ( true )
89+import Rel8.Order ( Order( Order ) )
43import Rel8.Query ( Query )
90import Rel8.Query ( Query )
44−import Rel8.Query.Aggregate ( aggregate )
91+import qualified Rel8.Query.Exists as Q ( exists, present, absent )
45−import Rel8.Query.Exists ( withBy, withoutBy )
92+import Rel8.Query.Filter ( where_ )
46−import Rel8.Query.Filter ( filter, where_ )
93+import Rel8.Query.List ( catNonEmptyTable )
47−import Rel8.Query.Maybe ( optional )
94+import qualified Rel8.Query.Maybe as Q ( optional )
95+import Rel8.Query.Opaleye ( mapOpaleye, unsafePeekQuery )
96+import Rel8.Query.Rebind ( rebind )
48import Rel8.Query.These ( alignBy )
97import Rel8.Query.These ( alignBy )
49−import Rel8.Table ( Table )
98+import Rel8.Table ( Table, fromColumns, toColumns )
50−import Rel8.Table.Aggregate ( groupBy )
99+import Rel8.Table.Aggregate ( hgroupBy, listAgg, nonEmptyAgg )
51−import Rel8.Table.Eq ( EqTable, (==:) )
100+import Rel8.Table.Alternative
52−import Rel8.Table.Maybe ( MaybeTable )
101+ ( AltTable, (<|>:)
53−import Rel8.Table.These ( TheseTable, theseTable )
102+ , AlternativeTable, emptyTable
54−import Rel8.Table.Undefined ( undefined )
103+ )
104+import Rel8.Table.Cols ( fromCols, toCols )
105+import Rel8.Table.Eq ( EqTable, (==:), eqTable )
106+import Rel8.Table.List ( ListTable( ListTable ) )
107+import Rel8.Table.Maybe ( MaybeTable( MaybeTable ), maybeTable )
108+import Rel8.Table.NonEmpty ( NonEmptyTable( NonEmptyTable ) )
109+import Rel8.Table.Opaleye ( aggregator, unpackspec )
110+import Rel8.Table.Ord ( OrdTable )
111+import Rel8.Table.Order ( ascTable )
112+import Rel8.Table.Projection
113+ ( Biprojectable, biproject
114+ , Projectable, project
115+ , apply
116+ )
117+import Rel8.Table.These ( TheseTable( TheseTable ), theseTable )
55
118
56-- semigroupoids
119-- semigroupoids
57import Data.Functor.Apply ( Apply, liftF2 )
120import Data.Functor.Apply ( Apply, liftF2 )
58−import Data.Functor.Bind ( Bind )
121+import Data.Functor.Bind ( Bind, (>>-) )
59−import qualified Data.Functor.Bind
122+
60−import Data.Semigroup.Traversable.Class ( bitraverse1 )
123+
124+type Key :: Type -> Type
125+type Key = Maybe
126+
127+
128+cat :: Table Expr k => Key k -> Query k
129+cat = maybe emptyTable pure
130+
131+
132+key :: (ProductProfunctor p, SumProfunctor p)
133+ => p a b -> p (Key a) (Key b)
134+key a = dimap from to (PP.empty +++! a)
135+ where
136+ from = maybe (Left ()) Right
137+ to = either (const Nothing) Just
138+
139+
140+keyed :: (ProductProfunctor p, SumProfunctor p)
141+ => p k l -> p a b -> p (Key k, a) (Key l, b)
142+keyed k a = key k ***! a
143+
144+
145+type Predicate :: Type -> Type
146+newtype Predicate a = Predicate (Maybe (a -> Expr Bool))
147+
148+
149+instance Contravariant Predicate where
150+ contramap f (Predicate a) = Predicate (lmap f <$> a)
151+
152+
153+instance Semigroup (Predicate k) where
154+ Predicate ma <> Predicate mb = Predicate $ ma <|> mb
155+
156+
157+instance Monoid (Predicate k) where
158+ mempty = Predicate Nothing
159+
160+
161+match :: EqTable k => Key k -> Predicate k
162+match = Predicate . fmap (==:)
163+
164+
165+ensure :: Predicate k -> Key k -> Query ()
166+ensure (Predicate mp) = traverse_ (\k -> traverse_ (\p -> where_ (p k)) mp)
61
167
62
168
63−-- | @'Tabulation' k a@ is denotionally a @MultiMap k a@ — a @Map@ where each
169+-- | A @'Tabulation' k a@ is like a @'Query' a@, except that each row also
64−-- key @k@ corresponds to potentially multiple @a@ (i.e., @'Query' a@). This
170+-- has a key @k@ in addition to the value @a@. 'Tabulation's can be composed
65−-- @MultiMap@ supports 'lookup' and other operations you would expect it to.
171+-- monadically just like 'Query's, but the resulting join is more like a
172+-- @NATURAL JOIN@ (based on the common key column(s) @k@) than the
173+-- @CROSS JOIN@ given by 'Query'.
66--
174--
67−-- \"Identity\" 'Tabulation's are created using 'tabulate'. 'Tabulation's can
175+-- Another way to think of @'Tabulation' k a@ is as analogous to @Map k a@ in
68−-- be composed with 'Query's with 'prebind' or 'postbind' to form new
176+-- the same way @'Query' a@ is analogous to @[a]@. However, there's nothing
69−-- 'Tabulation's.
177+-- stopping a 'Tabulation' from containing multiple rows with the same key, so
70−newtype Tabulation k a = Tabulation (k -> Query (Maybe k, a))
178+-- technically @Map k (NonEmpty a)@ is more accurate.
71− deriving stock Functor
179+--
180+-- 'Tabulation's can be created from 'Query's with 'fromQuery' and 'liftQuery'
181+-- and converted back to 'Query's with 'lookup' and 'toQuery' (though note the
182+-- caveats that come with the latter).
183+type Tabulation :: Type -> Type -> Type
184+newtype Tabulation k a = Tabulation (Predicate k -> Query (Key k, a))
185+
186+
187+instance Biprojectable Tabulation where
188+ biproject f g =
189+ bimap
190+ (fromColumns . apply f . toColumns)
191+ (fromColumns . apply g . toColumns)
192+
193+
194+instance Bifunctor Tabulation where
195+ bimap f g (Tabulation a) = Tabulation $ \p ->
196+ bimap (fmap f) g <$> a (f >$< p)
197+
198+
199+instance Functor (Tabulation k) where
200+ fmap = second
72
201
73
202
203+instance Projectable (Tabulation k) where
204+ project f = fmap (fromColumns . apply f . toColumns)
205+
206+
207+-- | If @'Tabulation' k a@ is @Map k (NonEmpty a)@, then @(<.>)@ is
208+-- @intersectionWith (liftA2 (<*>))@
74instance EqTable k => Apply (Tabulation k) where
209instance EqTable k => Apply (Tabulation k) where
75 liftF2 = liftA2
210 liftF2 = liftA2
76
211
77
212
213+-- | @pure = 'liftQuery' . pure@
78instance EqTable k => Applicative (Tabulation k) where
214instance EqTable k => Applicative (Tabulation k) where
79 pure = liftQuery . pure
215 pure = liftQuery . pure
80 liftA2 = liftM2
216 liftA2 = liftM2
81
217
82
218
83instance EqTable k => Bind (Tabulation k) where
219instance EqTable k => Bind (Tabulation k) where
84− join = join
220+ Tabulation as >>- f = Tabulation $ \p -> do
221+ (k, a) <- as p
222+ case f a of
223+ Tabulation bs -> do
224+ let p' = match k
225+ (k', b) <- bs (p' <> p)
226+ ensure p' k'
227+ pure (k' <|> k, b)
85
228
86
229
87instance EqTable k => Monad (Tabulation k) where
230instance EqTable k => Monad (Tabulation k) where
88− Tabulation as >>= f = Tabulation $ \i -> do
231+ (>>=) = (>>-)
89− (mk, a) <- as i
90− case mk of
91− Nothing -> case f a of
92− Tabulation bs -> bs i
93− Just k -> case f a of
94− Tabulation bs -> do
95− (mk', b) <- bs k
96− case mk' of
97− Nothing -> pure (mk, b)
98− Just k' -> do
99− where_ $ k ==: k'
100− pure (mk', b)
101−
102−
103−-- | This "undoes" 'fromQuery'.
104−--
105−-- @
106−-- 'runTabulation' . 'fromQuery' = id
107−-- 'fromQuery' . 'runTabulation' = id
108−-- @
109−--
110−-- Note however that it produces nonsense when passed a 'Tabulation' that was
111−-- made with from 'liftQuery' or 'pure'. In such cases the returned 'Query'
112−-- will always produce zero rows.
113−runTabulation :: EqTable k => Tabulation k a -> Query (k, a)
114−runTabulation (Tabulation f) = do
115− (mk, a) <- f i
116− case mk of
117− Nothing -> do
118− -- Opaleye tries to be too clever optimising "WHERE FALSE" and generates
119− -- invalid SQL, so we use "WHERE NOT TRUE" instead
120− where_ $ not_ true
121− pure (i, a)
122− Just k -> pure (k, a)
123− where
124− i = undefined
125
232
126
233
127−liftQuery :: Query a -> Tabulation k a
234+-- | If @'Tabulation' k a@ is @Map k (NonEmpty a)@, then @(<|>:)@ is
128−liftQuery query = Tabulation $ const $ fmap (Nothing,) query
235+-- @unionWith (<>)@.
236+instance EqTable k => AltTable (Tabulation k) where
237+ tas <|>: tbs = do
238+ eas <- peek tas
239+ ebs <- peek tbs
240+ case (eas, ebs) of
241+ (Left as, Left bs) -> liftQuery $ as <|>: bs
242+ (Right as, Right bs) -> fromQuery $ as <|>: bs
243+ _ -> catNonEmptyTable `through` ((<>) `on` some) tas tbs
244+
245+
246+instance EqTable k => AlternativeTable (Tabulation k) where
247+ emptyTable = Tabulation $ const $ fmap (empty,) emptyTable
248+
249+
250+-- | If @'Tabulation' k a@ is @Map k (NonEmpty a)@, then @(<>)@ is
251+-- @unionWith (liftA2 (<>))@.
252+instance (EqTable k, Table Expr a, Semigroup a) => Semigroup (Tabulation k a)
253+ where
254+ (<>) = alignWith (theseTable id id (<>))
255+
256+
257+instance (EqTable k, Table Expr a, Semigroup a) => Monoid (Tabulation k a)
258+ where
259+ mempty = emptyTable
129
260
130
261
131−-- | 'tabulate' creates an \"identity\" @'Tabulation' k a@ that allows @a@ be
262+-- | Any 'Query' of key-value pairs @(k, a)@ can be a @'Tabulation' k a@.
132−-- indexed by one or more of its columns @k@. Some examples:
263+fromQuery :: Query (k, a) -> Tabulation k a
264+fromQuery = Tabulation . const . fmap (first pure)
265+
266+
267+-- | Convert a @'Tabulation' k a@ back into a 'Query' of key-value pairs.
133--
268--
134−-- [Tabulation by primary key]:
269+-- Note that the result of a 'toQuery' is undefined (will always return zero
135−-- @
270+-- rows) on 'Tabulation's constructed with 'liftQuery' or 'pure'. So while
136−-- projectsById :: Project 'Expr' -> 'Tabulation' ('Expr' ProjectId) (Project 'Expr')
271+-- @toQuery . fromQuery@ is always @id@, @fromQuery . toQuery@ is not.
137−-- projectsById = 'tabulate' projectId
272+--
138−-- @
273+-- A safer, more predictable alternative to 'toQuery' is to use 'lookup' with
274+-- an explicit set of keys:
275+--
276+-- @
277+-- do
278+-- k <- keys
279+-- a <- lookup k tabulation
280+-- pure (k, a)
281+-- @
139--
282--
140−-- Note: the nature of primary keys means that each key will be mapped to a
283+-- Having said that, in practice, most legitimate uses of 'Tabulation' will
141−-- singleton value in this case.
284+-- have a well-defined 'toQuery'. It would be possible in theory to encode
285+-- the necessary invariants at the type level using an indexed monad, but we
286+-- would lose the ability to use @do@-notation, which is the main benefit
287+-- of having 'Tabulation' as a monad in the first place.
142--
288--
143−-- [Tabulation by other unique key]:
289+-- In particular, @'toQuery' t@ is well-defined for any 'Tabulation' @t@
144−-- @
290+-- defined as @t = fromQuery _@. @'toQuery' t@ is also well-defined for any
145−-- projectsByName :: Project 'Expr' -> 'Tabulation' ('Expr' Text) (Project 'Expr')
291+-- 'Tabulation' @t@ defined as @t = t' >>= _@ or @t = t' *> _@ where
146−-- projectsByName = 'tabulate' projectName
292+-- @'toQuery' t'@ is well-defined. There are other valid permutations too.
147−-- @
293+-- Generally, anything that uses 'fromQuery' at some point, unless wrapped in
294+-- a top-level 'present' or 'absent', will have a well-defined 'toQuery'.
295+toQuery :: Table Expr k => Tabulation k a -> Query (k, a)
296+toQuery (Tabulation f) = do
297+ (mk, a) <- f mempty
298+ k <- cat mk
299+ pure (k, a)
300+
301+
302+-- | A @'Query' a@ can be treated as a @'Tabulation' k a@ where the given @a@
303+-- values exist at every possible key @k@.
304+liftQuery :: Query a -> Tabulation k a
305+liftQuery = Tabulation . const . fmap (empty,)
306+
307+
308+-- | Run a Kleisli arrow in the the 'Query' monad \"through\" a 'Tabulation'.
309+-- Useful for 'Rel8.filter'ing a 'Tabulation'.
148--
310--
149−-- [Tabulation by foreign key (tabulate a child table by parent key)]:
311+-- @
150−-- @
312+-- 'Rel8.filter' ((>=. 30) . userAge) `'through'` usersById
151−-- revisionsByProjectId :: Revision 'Expr' -> 'Tabulation' ('Expr' ProjectId) (Revision 'Expr')
313+-- @
152−-- revisionsByProjectId = 'tabulate' revisionProjectId
314+through :: (a -> Query b) -> Tabulation k a -> Tabulation k b
153−-- @
315+through f (Tabulation as) = Tabulation $ \p -> do
154−tabulate :: (a -> k) -> a -> Tabulation k a
316+ (k, a) <- as p
155−tabulate key a = fromQuery $ pure (key a, a)
317+ b <- f a
318+ pure (k, b)
319+infixr 1 `through`
156
320
157
321
158−-- | Like 'tabulate' but takes a monadic 'Query' function instead of a pure
322+-- | @'lookup' k t@ returns the value(s) at the key @k@ in the tabulation @t@.
159−-- one. This means you can filter rows while calculating the key, which is
323+lookup :: EqTable k => k -> Tabulation k a -> Query a
160−-- useful in conjunction with 'Rel8.Extra.catNulls'.
324+lookup k (Tabulation f) = do
161−tabulateA :: (a -> Query k) -> a -> Tabulation k a
325+ (k', a) <- f p
162−tabulateA key a = fromQuery $ (,a) <$> key a
326+ ensure p k'
327+ pure a
328+ where
329+ p = match (pure k)
163
330
164
331
165−-- | Analgous to 'Data.Map.Strict.fromList'.
332+-- | 'aggregate' aggregates the values within each key of a
166−fromQuery :: Query (k, a) -> Tabulation k a
333+-- 'Tabulation'. There is an implicit @GROUP BY@ on all the key columns.
167−fromQuery = Tabulation . const . fmap (first Just)
334+aggregate :: forall k aggregates exprs.
335+ ( EqTable k
336+ , Aggregates aggregates exprs
337+ )
338+ => Tabulation k aggregates -> Tabulation k exprs
339+aggregate (Tabulation f) = Tabulation $
340+ mapOpaleye (Opaleye.aggregate (keyed haggregator aggregator)) .
341+ fmap (first (fmap (hgroupBy (eqTable @k) . toColumns))) .
342+ f
343+ where
344+ haggregator = dimap fromColumns fromCols aggregator
168
345
169
346
170−indexed :: Tabulation k a -> Tabulation k (k, a)
347+-- | 'distinct' ensures a 'Tabulation' has at most one value for
171−indexed (Tabulation query) = Tabulation $ \i ->
348+-- each key, i.e., it drops duplicates. In general it keeps only the
172− (\(mk, a) -> (mk, (fromMaybe i mk, a))) <$> query i
349+-- \"first\" value it encounters for each key, but note that \"first\" is
350+-- undefined unless you first call 'order'.
351+distinct :: EqTable k => Tabulation k a -> Tabulation k a
352+distinct (Tabulation f) = Tabulation $
353+ mapOpaleye (Opaleye.distinctOnExplicit (key unpackspec) fst) . f
173
354
174
355
175−ifilter :: (k -> a -> Expr Bool) -> Tabulation k a -> Tabulation k a
356+-- | 'order' orders the /values/ of a 'Tabulation' within their
176−ifilter f tabulation = snd <$> do
357+-- respective keys. This specifies a defined order for 'distinct'.
177− filter (uncurry f) `postbind` indexed tabulation
358+-- It also defines the order of the lists produced by 'many' and
359+-- 'some'.
360+order :: OrdTable k => Order a -> Tabulation k a -> Tabulation k a
361+order ordering (Tabulation f) =
362+ Tabulation $ mapOpaleye (Opaleye.orderBy ordering') . f
363+ where
364+ Order ordering' = runClown (keyed (Clown ascTable) (Clown ordering))
178
365
179
366
180−-- | Map a 'Query' over the input side of a 'Tabulation'.
367+-- $magic
181−prebind :: (a -> Tabulation k b) -> Query a -> Tabulation k b
368+--
182−prebind f as = Tabulation $ \k -> do
369+-- Some of the following combinators produce \"magic\" 'Tabulation's. Let's
183− a <- as
370+-- use 'count' as an example to demonstrate this concept. Consider
184− case f a of
371+-- the following:
185− Tabulation query -> query k
372+--
186−infixr 1 `prebind`
373+-- @
374+-- count $ fromQuery $ values
375+-- [ (lit 'a', lit True)
376+-- , (lit 'a', lit False)
377+-- , (lit 'b', lit True)
378+-- ]
379+-- @
380+--
381+-- You might expect this to be equivalent to the following 'Tabulation':
382+--
383+-- @
384+-- fromQuery $ values
385+-- [ (lit 'a', 2)
386+-- , (lit 'b', 1)
387+-- ]
388+-- @
389+--
390+-- However, it isn't quite. While the resulting 'Tabulation' does effectively
391+-- contain the above entries, it also behaves as though it contained the value
392+-- @0@ at every other possible key.
393+--
394+-- This means you can do:
395+--
396+-- @
397+-- do
398+-- user <- usersById
399+-- orderCount <- count ordersByUserId
400+-- @
401+--
402+-- To see how many orders a user has (getting @0@ if they have no orders).
187
403
188
404
189−-- | Map a 'Query' over the output side of a 'Tabulation'.
405+-- | 'count' returns a count of how many entries are in the given
190−postbind :: (a -> Query b) -> Tabulation k a -> Tabulation k b
406+-- 'Tabulation' at each key.
191−postbind f (Tabulation as) = Tabulation $ \i -> do
407+--
192− (k, a) <- as i
408+-- The resulting 'Tabulation' is \"magic\" in that the value @0@ exists at
193− case f a of
409+-- every possible key that wasn't in the given 'Tabulation'.
194− bs -> do
410+count :: EqTable k => Tabulation k a -> Tabulation k (Expr Int64)
195− b <- bs
411+count =
196− pure (k, b)
412+ fmap (maybeTable 0 id) .
197−infixr 1 `postbind`
413+ optional .
414+ aggregate .
415+ fmap (const countStar)
416+
417+
418+-- | 'optional' produces a \"magic\" 'Tabulation' whereby each
419+-- entry in the given 'Tabulation' is wrapped in 'Rel8.justTable', and every
420+-- other possible key contains a single 'Rel8.nothingTable'.
421+--
422+-- This is used to implement 'leftAlignWith'.
423+optional :: Tabulation k a -> Tabulation k (MaybeTable Expr a)
424+optional (Tabulation f) = Tabulation $ \p -> case p of
425+ Predicate Nothing -> fmap pure <$> f p
426+ _ -> fmap (\m -> (empty, snd <$> m)) $ Q.optional $ do
427+ (k, a) <- f p
428+ ensure p k
429+ pure (k, a)
430+
431+
432+-- | 'many' aggregates each entry with a particular key into a
433+-- single entry with all of the values contained in a 'ListTable'.
434+--
435+-- 'order' can be used to give this 'ListTable' a defined order.
436+--
437+-- The resulting 'Tabulation' is \"magic\" in that the value
438+-- @'Rel8.listTable []'@ exists at every possible key that wasn't in the given
439+-- 'Tabulation'.
440+many :: (EqTable k, Table Expr a)
441+ => Tabulation k a -> Tabulation k (ListTable Expr a)
442+many =
443+ fmap (maybeTable mempty (\(ListTable a) -> ListTable a)) .
444+ optional .
445+ aggregate .
446+ fmap (listAgg . toCols)
447+
448+
449+-- | 'some' aggregates each entry with a particular key into a
450+-- single entry with all of the values contained in a 'NonEmptyTable'.
451+--
452+-- 'order' can be used to give this 'NonEmptyTable' a defined order.
453+some :: (EqTable k, Table Expr a)
454+ => Tabulation k a -> Tabulation k (NonEmptyTable Expr a)
455+some =
456+ fmap (\(NonEmptyTable a) -> NonEmptyTable a) .
457+ aggregate .
458+ fmap (nonEmptyAgg . toCols)
459+
460+
461+-- | 'exists' produces a \"magic\" 'Tabulation' which contains the
462+-- value 'Rel8.true' at each key in the given 'Tabulation', and the value
463+-- 'Rel8.false' at every other possible key.
464+exists :: Tabulation k a -> Tabulation k (Expr Bool)
465+exists (Tabulation f) = Tabulation $ \p -> case p of
466+ Predicate Nothing -> (true <$) <$> f p
467+ _ -> fmap (empty,) $ Q.exists $ do
468+ (k, _) <- f p
469+ ensure p k
470+
471+
472+-- | 'present' produces a 'Tabulation' where a single @()@ row
473+-- exists for every key that was present in the given 'Tabulation'.
474+--
475+-- This is used to implement 'similarity'.
476+present :: Tabulation k a -> Tabulation k ()
477+present (Tabulation f) = Tabulation $ \p -> do
478+ Q.present $ do
479+ (k, _) <- f p
480+ ensure p k
481+ pure (empty, ())
198
482
199
483
200−-- | Note that because 'Tabulation' is a @MultiMap@, the 'Query' returned by
484+-- | 'absent' produces a 'Tabulation' where a single @()@ row exists
201−-- 'lookup' can and often does contain multiple results.
485+-- at every possible key that absent from the given 'Tabulation'.
202−lookup :: EqTable k => k -> Tabulation k a -> Query a
486+--
203−lookup key (Tabulation query) = do
487+-- This is used to implement 'difference'.
204− (mk, a) <- query key
488+absent :: Tabulation k a -> Tabulation k ()
205− traverse_ (where_ . (key ==:)) mk
489+absent (Tabulation f) = Tabulation $ \p -> do
206− pure a
490+ Q.absent $ do
491+ (k, _) <- f p
492+ ensure p k
493+ pure (empty, ())
207
494
208
495
209−-- | Analagous to
496+-- | Performs a @NATURAL FULL OUTER JOIN@ based on the common key columns.
210−-- [@align@](https://hackage.haskell.org/package/semialign/docs/Data-Semialign.html#v:align).
211--
497--
212−-- If 'zip' makes an @INNER JOIN@, then 'align' makes a @FULL OUTER JOIN@.
498+-- Analogous to 'Data.Semialign.align'.
213−align :: (EqTable k, Table Expr a, Table Expr b)
499+align :: EqTable k
214− => Tabulation k a -> Tabulation k b -> Tabulation k (TheseTable a b)
500+ => Tabulation k a -> Tabulation k b -> Tabulation k (TheseTable Expr a b)
215align = alignWith id
501align = alignWith id
216
502
217
503
218−-- | Analagous to
504+-- | Performs a @NATURAL FULL OUTER JOIN@ based on the common key columns.
219−-- [@alignWith@](https://hackage.haskell.org/package/semialign/docs/Data-Semialign.html#v:alignWith).
220--
505--
221−-- See 'zipWith' and 'align'.
506+-- Analogous to 'Data.Semialign.alignWith'.
222−alignWith :: (EqTable k, Table Expr a, Table Expr b)
507+alignWith :: EqTable k
223− => (TheseTable a b -> c)
508+ => (TheseTable Expr a b -> c)
224 -> Tabulation k a -> Tabulation k b -> Tabulation k c
509 -> Tabulation k a -> Tabulation k b -> Tabulation k c
225−alignWith f kas kbs = do
510+alignWith f (Tabulation as) (Tabulation bs) = Tabulation $ \p -> do
226− as <- toQuery kas
511+ tkab <- liftF2 (alignBy condition) as bs p
227− bs <- toQuery kbs
512+ k <- traverse (rebind "key") $ recover $ bimap fst fst tkab
228− fromQuery $ do
513+ let
229− tkab <- alignBy (\(l, _) (m, _) -> l ==: m) as bs
514+ tab = bimap snd snd tkab
230− let
515+ pure (k, f tab)
231− k' = theseTable fst fst (const fst) tkab
516+ where
232− tab = bimap snd snd tkab
517+ condition (k, _) (k', _) = fromMaybe true (liftA2 (==:) k k')
233− pure (k', f tab)
518+ recover (TheseTable mma@(MaybeTable _ ma) mmb@(MaybeTable _ mb)) =
234−
519+ case extract ma of
235−
520+ Nothing -> extract mb
236−-- | If 'zip' makes an @INNER JOIN@, then 'leftAlign' makes a @LEFT JOIN@.
521+ Just a -> case extract mb of
237−-- This means it will return at least one row for every row in the left
522+ Nothing -> extract ma
238−-- 'Tabulation', even if there is no corresponding row in the right (hence the
523+ Just b -> case a <$ mma <|>: b <$ mmb of
239−-- 'Rel8.MaybeTable').
524+ MaybeTable _ c -> pure (extract c)
240−--
525+
241−-- Analagous to
526+
242−-- [@rpadZip@](https://hackage.haskell.org/package/semialign/docs/Data-Semialign.html#v:rpadZip).
527+-- | Performs a @NATURAL LEFT OUTER JOIN@ based on the common key columns.
528+--
529+-- Analogous to 'Data.Semialign.rpadZip'.
530+--
531+-- Note that you can achieve the same effect with 'optional' and the
532+-- 'Applicative' instance for 'Tabulation', i.e., this is just
533+-- @\left right -> liftA2 (,) left (optional right). You can also
534+-- use @do@-notation.
243leftAlign :: EqTable k
535leftAlign :: EqTable k
244− => Tabulation k a -> Tabulation k b -> Tabulation k (a, MaybeTable b)
536+ => Tabulation k a -> Tabulation k b -> Tabulation k (a, MaybeTable Expr b)
245leftAlign = leftAlignWith (,)
537leftAlign = leftAlignWith (,)
246
538
247
539
248−-- | See 'zipWith' and 'leftAlign'.
540+-- | Performs a @NATURAL LEFT OUTER JOIN@ based on the common key columns.
249--
541--
250−-- Analagous to
542+-- Analogous to 'Data.Semialign.rpadZipWith'.
251−-- [@rpadZipWith@](https://hackage.haskell.org/package/semialign/docs/Data-Semialign.html#v:rpadZipWith).
543+--
544+-- Note that you can achieve the same effect with 'optional' and the
545+-- 'Applicative' instance for 'Tabulation', i.e., this is just
546+-- @\f left right -> liftA2 f left (optional right). You can also
547+-- use @do@-notation.
252leftAlignWith :: EqTable k
548leftAlignWith :: EqTable k
253− => (a -> MaybeTable b -> c)
549+ => (a -> MaybeTable Expr b -> c)
254 -> Tabulation k a -> Tabulation k b -> Tabulation k c
550 -> Tabulation k a -> Tabulation k b -> Tabulation k c
255−leftAlignWith f left right = liftA2 f left (optionalTabulation right)
551+leftAlignWith f left right = liftA2 f left (optional right)
256
552
257
553
258−-- | Analagous to
554+-- | Performs a @NATURAL RIGHT OUTER JOIN@ based on the common key columns.
259−-- [@zip@](https://hackage.haskell.org/package/semialign/docs/Data-Semialign.html#v:zip).
555+--
556+-- Analogous to 'Data.Semialign.lpadZip'.
260--
557--
261−-- There are multiple correct ways of understanding what this does.
558+-- Note that you can achieve the same effect with 'optional' and the
559+-- 'Applicative' instance for 'Tabulation', i.e., this is just
560+-- @\left right -> liftA2 (flip (,)) right (optional left). You can
561+-- also use @do@-notation.
562+rightAlign :: EqTable k
563+ => Tabulation k a -> Tabulation k b -> Tabulation k (MaybeTable Expr a, b)
564+rightAlign = rightAlignWith (,)
565+
566+
567+-- | Performs a @NATURAL RIGHT OUTER JOIN@ based on the common key columns.
262--
568--
263−-- You can think of it as @'Data.Map.Strict.intersectionWith'
569+-- Analogous to 'Data.Semialign.lpadZipWith'.
264−-- ('Control.Applicative.liftA2' (,))@. That is, @intersect@ the two
265−-- `Tabulation`s by matching their keys together (with 'Rel8.==:'), and combine
266−-- their values (remembering that 'Tabulation' is a 'MultiMap' so that the
267−-- values are keys) by getting their cartesian product.
268--
570--
269−-- You can think of it as performing a cross product of the underlying 'Query's
571+-- Note that you can achieve the same effect with 'optional' and the
270−-- of the given 'Tabulation's and filtering the results for 'match'ing keys.
572+-- 'Applicative' instance for 'Tabulation', i.e., this is just
573+-- @\f left right -> liftA2 (flip f) right (optional left). You can
574+-- also use @do@-notation.
575+rightAlignWith :: EqTable k
576+ => (MaybeTable Expr a -> b -> c)
577+ -> Tabulation k a -> Tabulation k b -> Tabulation k c
578+rightAlignWith f left right = liftA2 (flip f) right (optional left)
579+
580+
581+-- | Performs a @NATURAL INNER JOIN@ based on the common key columns.
271--
582--
272−-- You can think of it as a natural join in SQL terms.
583+-- Analagous to 'Data.Semialign.zip'.
273--
584--
274−-- The size of the resulting 'Tabulation' will be \(\sum_{k} min(n_k, m_k) \)
585+-- Note that you can achieve the same effect with the 'Applicative' instance
275−-- in terms of the number of keys, but \(\sum_{k} n_k \times m_k\) in terms of
586+-- of 'Tabulation', i.e., this is just @'liftA2 (,)'@. You can also use
276−-- the number of values.
587+-- @do@-notation.
277zip :: EqTable k
588zip :: EqTable k
278 => Tabulation k a -> Tabulation k b -> Tabulation k (a, b)
589 => Tabulation k a -> Tabulation k b -> Tabulation k (a, b)
279zip = zipWith (,)
590zip = zipWith (,)
280
591
281
592
282−-- | Analagous to
593+-- | Performs a @NATURAL INNER JOIN@ based on the common key columns.
283−-- [@zipWith@](https://hackage.haskell.org/package/semialign/docs/Data-Semialign.html#v:zipWith).
284--
594--
285−-- See 'zip'.
595+-- Analagous to 'Data.Semialign.zipWith'.
596+--
597+-- Note that you can achieve the same effect with the 'Applicative' instance
598+-- of 'Tabulation', i.e., this is just @'liftA2'@. You can also use
599+-- @do@-notation.
286zipWith :: EqTable k
600zipWith :: EqTable k
287 => (a -> b -> c) -> Tabulation k a -> Tabulation k b -> Tabulation k c
601 => (a -> b -> c) -> Tabulation k a -> Tabulation k b -> Tabulation k c
288zipWith = liftA2
602zipWith = liftA2
289
603
290
604
291−-- | 'similarity' returns all the entries in the left 'Tabulation' that have a
605+-- | Performs a [@NATURAL SEMI JOIN@](https://en.wikipedia.org/wiki/Relational_algebra#Semijoin_%28%E2%8B%89%29%28%E2%8B%8A%29)
292−-- corresponding entry in the right 'Tabulation'. This corresponds to a
606+-- based on the common key columns.
293−-- semijoin in relational algebra.
294--
607--
295−-- This differs from @'zipWith' const x y@ when the right 'Tabulation' @y@
608+-- The result is a subset of the left tabulation where only entries which have
296−-- contains an entry with multiple rows. For 'similarity', the entries in the
609+-- a corresponding entry in the right tabulation are kept.
297−-- resulting 'Tabulation' will contain the same number of rows as their
298−-- respective entries in the left 'Tabulation' @x@. With `zipWith const x y`,
299−-- each entry would contain the /product/ of the number of rows of their
300−-- respective entries in @x@ and @y@.
301--
610--
302−-- See 'Rel8.with'.
611+-- Note that you can achieve a similar effect with 'present' and the
612+-- 'Applicative' instance of 'Tabulation', i.e., this is just
613+-- @\left right -> left <* present right@. You can also use
614+-- @do@-notation.
303similarity :: EqTable k => Tabulation k a -> Tabulation k b -> Tabulation k a
615similarity :: EqTable k => Tabulation k a -> Tabulation k b -> Tabulation k a
304−similarity kas kbs = do
616+similarity a b = a <* present b
305− as <- toQuery kas
306− bs <- toQuery kbs
307− fromQuery $ as >>= withBy (\(k, _) (l, _) -> k ==: l) bs
308
617
309
618
310−-- | 'difference' returns all the entries in the left 'Tabulation' that don't
619+-- | Performs a [@NATURAL ANTI JOIN@](https://en.wikipedia.org/wiki/Relational_algebra#Antijoin_%28%E2%96%B7%29)
311−-- exist in the right 'Tabulation'. This corresponds to an antijoin in
620+-- based on the common key columns.
312−-- relational algebra.
621+--
622+-- The result is a subset of the left tabulation where only entries which do
623+-- not have a corresponding entry in the right tabulation are kept.
313--
624--
314−-- See 'Rel8.without'.
625+-- Note that you can achieve a similar effect with 'absent' and the
626+-- 'Applicative' instance of 'Tabulation', i.e., this is just
627+-- @\left right -> left <* absent right@. You can also use
628+-- @do@-notation.
315difference :: EqTable k => Tabulation k a -> Tabulation k b -> Tabulation k a
629difference :: EqTable k => Tabulation k a -> Tabulation k b -> Tabulation k a
316−difference kas kbs = do
630+difference a b = a <* absent b
317− as <- toQuery kas
318− bs <- toQuery kbs
319− fromQuery $ as >>= withoutBy (\(k, _) (l, _) -> k ==: l) bs
320−
321−
322−aggregateTabulation :: EqTable k
323− => Tabulation k (Aggregate a) -> Tabulation k a
324−aggregateTabulation kas = do
325− as <- toQuery kas
326− fromQuery $ aggregate $ bitraverse1 groupBy id <$> as
327−
328−
329−optionalTabulation :: EqTable k
330− => Tabulation k a -> Tabulation k (MaybeTable a)
331−optionalTabulation as = Tabulation $ \k -> do
332− ma <- optional $ lookup k as
333− pure (Just k, ma)
334
631
335
632
336−toQuery :: Tabulation k a -> Tabulation k (Query (k, a))
633+-- | 'Tabulation's can be produced with either 'fromQuery' or 'liftQuery', and
337−toQuery (Tabulation as) = Tabulation $ \k ->
634+-- in some cases we might want to treat these differently. 'peek' uses
338− pure (Nothing, first (fromMaybe k) <$> as k)
635+-- 'unsafePeekQuery' to determine which type of 'Tabulation' we have.
636+peek :: Tabulation k a -> Tabulation k (Either (Query a) (Query (k, a)))
637+peek (Tabulation f) = Tabulation $ \p ->
638+ pure $ (empty,) $ case unsafePeekQuery (f p) of
639+ (Nothing, _) -> Left $ fmap snd (f p)
640+ (Just _, _) -> Right $ fmap (first fromJust) (f p)
src/Rel8/Type.hs+9−8
@@ -1,3 +1,4 @@
1+{-# language FlexibleContexts #-}
1{-# language FlexibleInstances #-}
2{-# language FlexibleInstances #-}
2{-# language MonoLocalBinds #-}
3{-# language MonoLocalBinds #-}
3{-# language MultiWayIf #-}
4{-# language MultiWayIf #-}
@@ -127,10 +128,10 @@ instance DBType Int64 where
127instance DBType Float where
128instance DBType Float where
128 typeInformation = TypeInformation
129 typeInformation = TypeInformation
129 { encode = \x -> Opaleye.ConstExpr
130 { encode = \x -> Opaleye.ConstExpr
130− if | x == (1 /0) -> Opaleye.OtherLit "'Infinity'"
131+ if | x == (1 / 0) -> Opaleye.OtherLit "'Infinity'"
131− | isNaN x -> Opaleye.OtherLit "'NaN'"
132+ | isNaN x -> Opaleye.OtherLit "'NaN'"
132− | x == (-1/0) -> Opaleye.OtherLit "'-Infinity'"
133+ | x == (-1 / 0) -> Opaleye.OtherLit "'-Infinity'"
133− | otherwise -> Opaleye.NumericLit $ realToFrac x
134+ | otherwise -> Opaleye.NumericLit $ realToFrac x
134 , decode = Hasql.float4
135 , decode = Hasql.float4
135 , typeName = "float4"
136 , typeName = "float4"
136 }
137 }
@@ -140,10 +141,10 @@ instance DBType Float where
140instance DBType Double where
141instance DBType Double where
141 typeInformation = TypeInformation
142 typeInformation = TypeInformation
142 { encode = \x -> Opaleye.ConstExpr
143 { encode = \x -> Opaleye.ConstExpr
143− if | x == (1 /0) -> Opaleye.OtherLit "'Infinity'"
144+ if | x == (1 / 0) -> Opaleye.OtherLit "'Infinity'"
144− | isNaN x -> Opaleye.OtherLit "'NaN'"
145+ | isNaN x -> Opaleye.OtherLit "'NaN'"
145− | x == (-1/0) -> Opaleye.OtherLit "'-Infinity'"
146+ | x == (-1 / 0) -> Opaleye.OtherLit "'-Infinity'"
146− | otherwise -> Opaleye.NumericLit $ realToFrac x
147+ | otherwise -> Opaleye.NumericLit $ realToFrac x
147 , decode = Hasql.float8
148 , decode = Hasql.float8
148 , typeName = "float8"
149 , typeName = "float8"
149 }
150 }
src/Rel8/Type/Array.hs+46−26
@@ -1,12 +1,13 @@
1{-# language GADTs #-}
1{-# language GADTs #-}
2+{-# language LambdaCase #-}
2{-# language NamedFieldPuns #-}
3{-# language NamedFieldPuns #-}
3{-# language OverloadedStrings #-}
4{-# language OverloadedStrings #-}
5+{-# language ViewPatterns #-}
4
6
5module Rel8.Type.Array
7module Rel8.Type.Array
6− ( array
8+ ( array, encodeArrayElement, extractArrayElement
7 , listTypeInformation
9 , listTypeInformation
8 , nonEmptyTypeInformation
10 , nonEmptyTypeInformation
9− , fromPrimArray, toPrimArray, zipPrimArraysWith
10 )
11 )
11where
12where
12
13
@@ -28,10 +29,9 @@ import Rel8.Type.Information ( TypeInformation(..), parseTypeInformation )
28
29
29array :: Foldable f
30array :: Foldable f
30 => TypeInformation a -> f Opaleye.PrimExpr -> Opaleye.PrimExpr
31 => TypeInformation a -> f Opaleye.PrimExpr -> Opaleye.PrimExpr
31−array TypeInformation {typeName} =
32+array info =
32− fromPrimArray .
33+ Opaleye.CastExpr (arrayType info <> "[]") .
33− Opaleye.CastExpr (typeName <> "[]") .
34+ Opaleye.ArrayExpr . map (encodeArrayElement info) . toList
34− Opaleye.ArrayExpr . toList
35{-# INLINABLE array #-}
35{-# INLINABLE array #-}
36
36
37
37
@@ -39,19 +39,23 @@ listTypeInformation :: ()
39 => Nullity a
39 => Nullity a
40 -> TypeInformation (Unnullify a)
40 -> TypeInformation (Unnullify a)
41 -> TypeInformation [a]
41 -> TypeInformation [a]
42−listTypeInformation nullity info =
42+listTypeInformation nullity info@TypeInformation {encode, decode} =
43− case info of
43+ TypeInformation
44− TypeInformation{ encode, decode } -> TypeInformation
44+ { decode = case nullity of
45− { decode = row $ case nullity of
45+ Null ->
46− Null -> Hasql.listArray (Hasql.nullable decode)
46+ Hasql.listArray (decodeArrayElement info (Hasql.nullable decode))
47− NotNull -> Hasql.listArray (Hasql.nonNullable decode)
47+ NotNull ->
48− , encode = case nullity of
48+ Hasql.listArray (decodeArrayElement info (Hasql.nonNullable decode))
49− Null -> array info . fmap (maybe null encode)
49+ , encode = case nullity of
50− NotNull -> array info . fmap encode
50+ Null ->
51− , typeName = "record"
51+ Opaleye.ArrayExpr .
52− }
52+ fmap (encodeArrayElement info . maybe null encode)
53+ NotNull ->
54+ Opaleye.ArrayExpr .
55+ fmap (encodeArrayElement info . encode)
56+ , typeName = arrayType info <> "[]"
57+ }
53 where
58 where
54− row = Hasql.composite . Hasql.field . Hasql.nonNullable
55 null = Opaleye.ConstExpr Opaleye.NullLit
59 null = Opaleye.ConstExpr Opaleye.NullLit
56
60
57
61
@@ -66,15 +70,31 @@ nonEmptyTypeInformation nullity =
66 message = "failed to decode NonEmptyList: got empty list"
70 message = "failed to decode NonEmptyList: got empty list"
67
71
68
72
69−fromPrimArray :: Opaleye.PrimExpr -> Opaleye.PrimExpr
73+isArray :: TypeInformation a -> Bool
70−fromPrimArray = Opaleye.UnExpr (Opaleye.UnOpOther "ROW")
74+isArray = \case
75+ (reverse . typeName -> ']' : '[' : _) -> True
76+ _ -> False
71
77
72
78
73−toPrimArray :: Opaleye.PrimExpr -> Opaleye.PrimExpr
79+arrayType :: TypeInformation a -> String
74−toPrimArray a = Opaleye.CompositeExpr a "f1"
80+arrayType info
81+ | isArray info = "record"
82+ | otherwise = typeName info
75
83
76
84
77−zipPrimArraysWith :: ()
85+decodeArrayElement :: TypeInformation a -> Hasql.NullableOrNot Hasql.Value x -> Hasql.NullableOrNot Hasql.Value x
78− => (Opaleye.PrimExpr -> Opaleye.PrimExpr -> Opaleye.PrimExpr)
86+decodeArrayElement info
79− -> Opaleye.PrimExpr -> Opaleye.PrimExpr -> Opaleye.PrimExpr
87+ | isArray info = Hasql.nonNullable . Hasql.composite . Hasql.field
80−zipPrimArraysWith f a b = fromPrimArray (f (toPrimArray a) (toPrimArray b))
88+ | otherwise = id
89+
90+
91+encodeArrayElement :: TypeInformation a -> Opaleye.PrimExpr -> Opaleye.PrimExpr
92+encodeArrayElement info
93+ | isArray info = Opaleye.UnExpr (Opaleye.UnOpOther "ROW")
94+ | otherwise = id
95+
96+
97+extractArrayElement :: TypeInformation a -> Opaleye.PrimExpr -> Opaleye.PrimExpr
98+extractArrayElement info
99+ | isArray info = flip Opaleye.CompositeExpr "f1"
100+ | otherwise = id
src/Rel8/Type/Array1D.hsdeleted−139
@@ -1,139 +0,0 @@
1−{-# language DataKinds #-}
2−{-# language DeriveTraversable #-}
3−{-# language DerivingStrategies #-}
4−{-# language FlexibleContexts #-}
5−{-# language FlexibleInstances #-}
6−{-# language GeneralizedNewtypeDeriving #-}
7−{-# language NamedFieldPuns #-}
8−{-# language StandaloneKindSignatures #-}
9−{-# language TypeFamilies #-}
10−{-# language UndecidableInstances #-}
11−
12−{-# options_ghc -fno-warn-redundant-constraints #-}
13−
14−module Rel8.Type.Array1D
15− ( Array1D( Array1D )
16− , NotArray
17− , getArray1D
18− )
19−where
20−
21−-- aeson
22−import Data.Aeson
23− ( ToJSON
24− , ToJSON1
25− , ToJSONKey
26− , FromJSON
27− , FromJSON1
28− , FromJSONKey
29− )
30−
31−-- base
32−import Control.Applicative ( Alternative, (<|>) )
33−import Control.Monad ( MonadPlus )
34−import Data.Functor.Classes ( Eq1, Ord1, Read1, Show1 )
35−import Data.Kind ( Type )
36−import GHC.Exts ( IsList )
37−import Prelude hiding ( null )
38−
39−-- hasql
40−import qualified Hasql.Decoders as Hasql
41−
42−-- opaleye
43−import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
44−
45−-- rel8
46−import Rel8.Expr.Opaleye ( zipPrimExprsWith )
47−import Rel8.Expr.Serialize ( litExpr )
48−import Rel8.Schema.Null ( Unnullify, Nullity( Null, NotNull ), Sql, nullable )
49−import Rel8.Type ( DBType, typeInformation )
50−import Rel8.Type.Eq ( DBEq )
51−import Rel8.Type.Information ( TypeInformation(..) )
52−import Rel8.Type.Monoid ( DBMonoid, memptyExpr )
53−import Rel8.Type.Ord ( DBMax, DBMin, DBOrd )
54−import Rel8.Type.Semigroup ( DBSemigroup, (<>.) )
55−
56−-- semigroupoids
57−import Data.Functor.Alt ( Alt, (<!>) )
58−import Data.Functor.Apply ( Apply )
59−import Data.Functor.Bind ( Bind )
60−import Data.Functor.Plus ( Plus )
61−
62−-- semialign
63−import Data.Align ( Align )
64−import Data.Semialign ( Semialign )
65−import Data.Zip ( Repeat, Unzip, Zip )
66−
67−
68−-- | A one dimensional array.
69−newtype Array1D a = Array1D [a]
70− deriving stock Traversable
71− deriving newtype
72− ( Eq, Ord, Read, Show, Semigroup, Monoid, IsList
73− , Functor, Foldable
74− , Eq1, Ord1, Read1, Show1
75− , FromJSON1, ToJSON1, FromJSON, FromJSONKey, ToJSON, ToJSONKey
76− , Apply, Applicative, Alternative, Plus, Bind, Monad, MonadPlus
77− , Align, Semialign, Repeat, Unzip, Zip
78− )
79−
80−
81−instance Alt Array1D where
82− (<!>) = (<|>)
83−
84−
85−getArray1D :: Array1D a -> [a]
86−getArray1D (Array1D a) = a
87−
88−
89−type IsArray1D :: Type -> Bool
90−type family IsArray1D a where
91− IsArray1D (Array1D _) = 'True
92− IsArray1D _ = 'False
93−
94−
95−class IsArray1D a ~ 'False => NotArray a
96−instance IsArray1D a ~ 'False => NotArray a
97−
98−
99−array1DTypeInformation :: Sql NotArray a
100− => Nullity a
101− -> TypeInformation (Unnullify a)
102− -> TypeInformation (Array1D a)
103−array1DTypeInformation nullity info =
104− case info of
105− TypeInformation{ encode, decode, typeName } -> TypeInformation
106− { decode = case nullity of
107− Null -> Array1D <$> Hasql.listArray (Hasql.nullable decode)
108− NotNull -> Array1D <$> Hasql.listArray (Hasql.nonNullable decode)
109− , encode = case nullity of
110− Null -> Opaleye.ArrayExpr . fmap (maybe null encode) . getArray1D
111− NotNull -> Opaleye.ArrayExpr . fmap encode . getArray1D
112− , typeName = typeName <> "[]"
113− }
114− where
115− null = Opaleye.ConstExpr Opaleye.NullLit
116−
117−
118−instance (Sql DBType a, Sql NotArray a) => DBType (Array1D a) where
119− typeInformation = array1DTypeInformation nullable typeInformation
120−
121−
122−instance (Sql DBEq a, Sql NotArray a) => DBEq (Array1D a)
123−
124−
125−instance (Sql DBOrd a, Sql NotArray a) => DBOrd (Array1D a)
126−
127−
128−instance (Sql DBMax a, Sql NotArray a) => DBMax (Array1D a)
129−
130−
131−instance (Sql DBMin a, Sql NotArray a) => DBMin (Array1D a)
132−
133−
134−instance (Sql DBType a, Sql NotArray a) => DBSemigroup (Array1D a) where
135− (<>.) = zipPrimExprsWith (Opaleye.BinExpr (Opaleye.:||))
136−
137−
138−instance (Sql DBType a, Sql NotArray a) => DBMonoid (Array1D a) where
139− memptyExpr = litExpr mempty
src/Rel8/Type/Composite.hs+90−39
@@ -1,27 +1,28 @@
1+{-# language AllowAmbiguousTypes #-}
2+{-# language BlockArguments #-}
1{-# language DataKinds #-}
3{-# language DataKinds #-}
2{-# language FlexibleContexts #-}
4{-# language FlexibleContexts #-}
3{-# language GADTs #-}
5{-# language GADTs #-}
6+{-# language NamedFieldPuns #-}
4{-# language ScopedTypeVariables #-}
7{-# language ScopedTypeVariables #-}
5{-# language StandaloneKindSignatures #-}
8{-# language StandaloneKindSignatures #-}
6{-# language TypeApplications #-}
9{-# language TypeApplications #-}
7−{-# language TypeOperators #-}
8{-# language UndecidableInstances #-}
10{-# language UndecidableInstances #-}
11+{-# language UndecidableSuperClasses #-}
12+{-# language ViewPatterns #-}
9
13
10module Rel8.Type.Composite
14module Rel8.Type.Composite
11 ( Composite( Composite )
15 ( Composite( Composite )
16+ , DBComposite( compositeFields, compositeTypeName )
17+ , compose, decompose
12 )
18 )
13where
19where
14
20
15-- base
21-- base
16−import Control.Applicative ( liftA2 )
22+import Data.Functor.Const ( Const( Const ), getConst )
23+import Data.Functor.Identity ( Identity( Identity ) )
17import Data.Kind ( Constraint, Type )
24import Data.Kind ( Constraint, Type )
18−import Data.Proxy ( Proxy( Proxy ) )
25+import Prelude
19−import GHC.Generics
20− ( Generic, Rep, from, to
21− , (:*:)( (:*:) ), K1( K1 ), M1( M1 )
22− )
23−import GHC.TypeLits ( KnownSymbol, Symbol, symbolVal )
24−import Prelude hiding ( null )
25
26
26-- hasql
27-- hasql
27import qualified Hasql.Decoders as Hasql
28import qualified Hasql.Decoders as Hasql
@@ -30,55 +31,105 @@ import qualified Hasql.Decoders as Hasql
30import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
31import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
31
32
32-- rel8
33-- rel8
33−import Rel8.Schema.Null ( Nullity( Null, NotNull ), Sql, nullable )
34+import Rel8.Expr ( Expr )
35+import Rel8.Expr.Opaleye ( castExpr, fromPrimExpr, toPrimExpr )
36+import Rel8.Schema.HTable ( HTable, hfield, hspecs, htabulate, htabulateA )
37+import Rel8.Schema.Name ( Name( Name ) )
38+import Rel8.Schema.Null ( Nullity( Null, NotNull ) )
39+import Rel8.Schema.Result ( Result )
40+import Rel8.Schema.Spec ( Spec( Spec, nullity, info ) )
41+import Rel8.Table ( fromColumns, toColumns, fromResult, toResult )
42+import Rel8.Table.Eq ( EqTable )
43+import Rel8.Table.HKD ( HKD, HKDable )
44+import Rel8.Table.Ord ( OrdTable )
45+import Rel8.Table.Rel8able ()
46+import Rel8.Table.Serialize ( litHTable )
34import Rel8.Type ( DBType, typeInformation )
47import Rel8.Type ( DBType, typeInformation )
48+import Rel8.Type.Eq ( DBEq )
35import Rel8.Type.Information ( TypeInformation(..) )
49import Rel8.Type.Information ( TypeInformation(..) )
50+import Rel8.Type.Ord ( DBOrd, DBMax, DBMin )
51+
52+-- semigroupoids
53+import Data.Functor.Apply ( WrappedApplicative(..) )
36
54
37
55
38-- | A deriving-via helper type for column types that store a Haskell product
56-- | A deriving-via helper type for column types that store a Haskell product
39-- type in a single Postgres column using a Postgres composite type.
57-- type in a single Postgres column using a Postgres composite type.
40--
58--
41-- Note that this must map to a specific extant type in your database's schema
59-- Note that this must map to a specific extant type in your database's schema
42−-- (created with @CREATE TYPE@). The @name@ parameter of @Composite@ should be
60+-- (created with @CREATE TYPE@). Use 'DBComposite' to specify the name of this
43−-- the name of this type.
61+-- Postgres type and the names of the individual fields (for projecting with
44−type Composite :: Symbol -> Type -> Type
62+-- 'decompose').
45−newtype Composite name a = Composite
63+type Composite :: Type -> Type
64+newtype Composite a = Composite
46 { unComposite :: a
65 { unComposite :: a
47 }
66 }
48
67
49
68
50−instance (KnownSymbol name, Generic a, GComposite (Rep a)) =>
69+instance DBComposite a => DBType (Composite a) where
51− DBType (Composite name a)
52− where
53 typeInformation = TypeInformation
70 typeInformation = TypeInformation
54− { decode = Hasql.composite (Composite . to <$> gdecode @(Rep a))
71+ { decode = Hasql.composite (Composite . fromResult @_ @(HKD a Expr) <$> decoder)
55− , encode = Opaleye.FunExpr "ROW" . gencode @(Rep a) . from . unComposite
72+ , encode = encoder . litHTable . toResult @_ @(HKD a Expr) . unComposite
56− , typeName = symbolVal (Proxy @name)
73+ , typeName = compositeTypeName @a
57 }
74 }
58
75
59
76
60−type GComposite :: (Type -> Type) -> Constraint
77+instance (DBComposite a, EqTable (HKD a Expr)) => DBEq (Composite a)
61−class GComposite rep where
78+
62− gdecode :: Hasql.Composite (rep x)
79+
63− gencode :: rep x -> [Opaleye.PrimExpr]
80+instance (DBComposite a, OrdTable (HKD a Expr)) => DBOrd (Composite a)
81+
82+
83+instance (DBComposite a, OrdTable (HKD a Expr)) => DBMax (Composite a)
64
84
65
85
66−instance GComposite rep => GComposite (M1 i c rep) where
86+instance (DBComposite a, OrdTable (HKD a Expr)) => DBMin (Composite a)
67− gdecode = M1 <$> gdecode
68− gencode (M1 a) = gencode a
69
87
70
88
71−instance (GComposite a, GComposite b) => GComposite (a :*: b) where
89+-- | 'DBComposite' is used to associate composite type metadata with a Haskell
72− gdecode = liftA2 (:*:) gdecode gdecode
90+-- type.
73− gencode (a :*: b) = gencode a <> gencode b
91+type DBComposite :: Type -> Constraint
92+class (DBType a, HKDable a) => DBComposite a where
93+ -- | The names of all fields in the composite type that @a@ maps to.
94+ compositeFields :: HKD a Name
74
95
96+ -- | The name of the composite type that @a@ maps to.
97+ compositeTypeName :: String
75
98
76−instance Sql DBType a => GComposite (K1 i a) where
99+
77− gdecode = fmap K1 $ Hasql.field $ case nullable @a of
100+-- | Collapse a 'HKD' into a PostgreSQL composite type.
78− Null -> Hasql.nullable (decode typeInformation)
101+--
79− NotNull -> Hasql.nonNullable (decode typeInformation)
102+-- 'HKD' values are represented in queries by having a column for each field in
80− gencode (K1 a) = case nullable @a of
103+-- the corresponding Haskell type. 'compose' collapses these columns into a
81− Null -> [maybe null (encode typeInformation) a]
104+-- single column expression, by combining them into a PostgreSQL composite
82− NotNull -> [encode typeInformation a]
105+-- type.
83− where
106+compose :: DBComposite a => HKD a Expr -> Expr a
84− null = Opaleye.ConstExpr Opaleye.NullLit
107+compose = castExpr . fromPrimExpr . encoder . toColumns
108+
109+
110+-- | Expand a composite type into a 'HKD'.
111+--
112+-- 'decompose' is the inverse of 'compose'.
113+decompose :: forall a. DBComposite a => Expr a -> HKD a Expr
114+decompose (toPrimExpr -> a) = fromColumns $ htabulate \field ->
115+ case hfield names field of
116+ Name name -> case hfield hspecs field of
117+ Spec {} -> fromPrimExpr $ Opaleye.CompositeExpr a name
118+ where
119+ names = toColumns (compositeFields @a)
120+
121+
122+decoder :: HTable t => Hasql.Composite (t Result)
123+decoder = unwrapApplicative $ htabulateA \field ->
124+ case hfield hspecs field of
125+ Spec {nullity, info} -> WrapApplicative $ Identity <$>
126+ case nullity of
127+ Null -> Hasql.field $ Hasql.nullable $ decode info
128+ NotNull -> Hasql.field $ Hasql.nonNullable $ decode info
129+
130+
131+encoder :: HTable t => t Expr -> Opaleye.PrimExpr
132+encoder a = Opaleye.FunExpr "ROW" exprs
133+ where
134+ exprs = getConst $ htabulateA \field -> case hfield a field of
135+ expr -> Const [toPrimExpr expr]
src/Rel8/Type/Enum.hs+86−33
@@ -1,27 +1,34 @@
1+{-# language AllowAmbiguousTypes #-}
1{-# language DataKinds #-}
2{-# language DataKinds #-}
2{-# language FlexibleContexts #-}
3{-# language FlexibleContexts #-}
3{-# language FlexibleInstances #-}
4{-# language FlexibleInstances #-}
4−{-# language GADTs #-}
5+{-# language LambdaCase #-}
6+{-# language RankNTypes #-}
5{-# language ScopedTypeVariables #-}
7{-# language ScopedTypeVariables #-}
6{-# language StandaloneKindSignatures #-}
8{-# language StandaloneKindSignatures #-}
7{-# language TypeApplications #-}
9{-# language TypeApplications #-}
10+{-# language TypeFamilies #-}
8{-# language TypeOperators #-}
11{-# language TypeOperators #-}
9{-# language UndecidableInstances #-}
12{-# language UndecidableInstances #-}
10
13
11module Rel8.Type.Enum
14module Rel8.Type.Enum
12− ( Enum(..)
15+ ( Enum( Enum )
16+ , DBEnum( enumValue, enumTypeName )
17+ , Enumable
13 )
18 )
14where
19where
15
20
16-- base
21-- base
22+import Control.Applicative ( (<|>) )
23+import Control.Arrow ( (&&&) )
17import Data.Kind ( Constraint, Type )
24import Data.Kind ( Constraint, Type )
18import Data.Proxy ( Proxy( Proxy ) )
25import Data.Proxy ( Proxy( Proxy ) )
19import GHC.Generics
26import GHC.Generics
20 ( Generic, Rep, from, to
27 ( Generic, Rep, from, to
21− , (:+:)( L1, R1 ), M1( M1 ), U1( U1 ), Meta( MetaCons )
28+ , (:+:)( L1, R1 ), M1( M1 ), U1( U1 )
22− , D, C
29+ , D, C, Meta( MetaCons )
23 )
30 )
24−import GHC.TypeLits ( KnownSymbol, Symbol, symbolVal )
31+import GHC.TypeLits ( KnownSymbol, symbolVal )
25import Prelude hiding ( Enum )
32import Prelude hiding ( Enum )
26
33
27-- hasql
34-- hasql
@@ -32,55 +39,101 @@ import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
32
39
33-- rel8
40-- rel8
34import Rel8.Type ( DBType, typeInformation )
41import Rel8.Type ( DBType, typeInformation )
42+import Rel8.Type.Eq ( DBEq )
35import Rel8.Type.Information ( TypeInformation(..) )
43import Rel8.Type.Information ( TypeInformation(..) )
44+import Rel8.Type.Ord ( DBOrd, DBMax, DBMin )
36
45
37-- text
46-- text
38−import Data.Text ( unpack )
47+import Data.Text ( pack )
39
48
40
49
41-- | A deriving-via helper type for column types that store an \"enum\" type
50-- | A deriving-via helper type for column types that store an \"enum\" type
42-- (in Haskell terms, a sum type where all constructors are nullary) using a
51-- (in Haskell terms, a sum type where all constructors are nullary) using a
43-- Postgres @enum@ type.
52-- Postgres @enum@ type.
44--
53--
45−-- Note that this must map to a specific type in your database's schema
54+-- Note that this should map to a specific type in your database's schema
46−-- (explicitly created with @CREATE TYPE ... AS ENUM@). The @name@ parameter
55+-- (explicitly created with @CREATE TYPE ... AS ENUM@). Use 'DBEnum' to
47−-- of @Enum@ should be the name of this type. Note also the names of the
56+-- specify the name of this Postgres type and the names of the individual
48−-- Postgres @enum@'s values are assumed to match exactly the names of the
57+-- values. If left unspecified, the names of the values of the Postgres
49−-- constructors of the Haskell type (up to and including case sensitivity).
58+-- @enum@ are assumed to match exactly exactly the names of the constructors
50−type Enum :: Symbol -> Type -> Type
59+-- of the Haskell type (up to and including case sensitivity).
51−newtype Enum name a = Enum
60+type Enum :: Type -> Type
61+newtype Enum a = Enum
52 { unEnum :: a
62 { unEnum :: a
53 }
63 }
54
64
55
65
56−instance (KnownSymbol name, Generic a, GEnum (Rep a)) => DBType (Enum name a)
66+instance DBEnum a => DBType (Enum a) where
57− where
58 typeInformation = TypeInformation
67 typeInformation = TypeInformation
59− { decode = Hasql.enum ((`lookup` (fmap (Enum . to) <$> gdecode)) . unpack)
68+ { decode =
60− , encode = Opaleye.ConstExpr . Opaleye.StringLit . gencode . from . unEnum
69+ Hasql.enum $
61− , typeName = symbolVal (Proxy @name)
70+ flip lookup $
71+ map ((pack . enumValue &&& Enum) . to) $
72+ genumerate @(Rep a)
73+ , encode =
74+ Opaleye.ConstExpr .
75+ Opaleye.StringLit .
76+ enumValue @a .
77+ unEnum
78+ , typeName = enumTypeName @a
62 }
79 }
63
80
64
81
65−type GEnum :: (Type -> Type) -> Constraint
82+instance DBEnum a => DBEq (Enum a)
66−class GEnum rep where
83+
67− gdecode :: [(String, rep x)]
84+
68− gencode :: rep x -> String
85+instance DBEnum a => DBOrd (Enum a)
86+
87+
88+instance DBEnum a => DBMax (Enum a)
89+
90+
91+instance DBEnum a => DBMin (Enum a)
92+
69
93
94+-- | @DBEnum@ contains the necessary metadata to describe a PostgreSQL @enum@ type.
95+type DBEnum :: Type -> Constraint
96+class (DBType a, Enumable a) => DBEnum a where
97+ -- | Map Haskell values to the corresponding element of the @enum@ type. The
98+ -- default implementation of this method will use the exact name of the
99+ -- Haskell constructors.
100+ enumValue :: a -> String
101+ enumValue = gshow @(Rep a) . from
70
102
71−instance GEnum rep => GEnum (M1 D c rep) where
103+ -- | The name of the PostgreSQL @enum@ type that @a@ maps to.
72− gdecode = fmap M1 <$> gdecode
104+ enumTypeName :: String
73− gencode (M1 a) = gencode a
74
105
75
106
76−instance (GEnum a, GEnum b) => GEnum (a :+: b) where
107+-- | Types that are sum types, where each constructor is unary (that is, has no
77− gdecode = (fmap L1 <$> gdecode) <> (fmap R1 <$> gdecode)
108+-- fields).
78− gencode (L1 a) = gencode a
109+type Enumable :: Type -> Constraint
79− gencode (R1 a) = gencode a
110+class (Generic a, GEnumable (Rep a)) => Enumable a
111+instance (Generic a, GEnumable (Rep a)) => Enumable a
80
112
81
113
82−instance (KnownSymbol name, a ~ U1) =>
114+type GEnumable :: (Type -> Type) -> Constraint
83− GEnum (M1 C ('MetaCons name f r) a)
115+class GEnumable rep where
116+ genumerate :: [rep x]
117+ gshow :: rep x -> String
118+
119+
120+instance GEnumable rep => GEnumable (M1 D meta rep) where
121+ genumerate = M1 <$> genumerate
122+ gshow (M1 rep) = gshow rep
123+
124+
125+instance (GEnumable a, GEnumable b) => GEnumable (a :+: b) where
126+ genumerate = L1 <$> genumerate <|> R1 <$> genumerate
127+ gshow = \case
128+ L1 a -> gshow a
129+ R1 a -> gshow a
130+
131+
132+instance
133+ ( meta ~ 'MetaCons name _fixity _isRecord
134+ , KnownSymbol name
135+ )
136+ => GEnumable (M1 C meta U1)
84 where
137 where
85− gdecode = [(symbolVal (Proxy @name), M1 U1)]
138+ genumerate = [M1 U1]
86− gencode _ = symbolVal (Proxy @name)
139+ gshow (M1 U1) = symbolVal (Proxy @name)
src/Rel8/Type/JSONBEncoded.hs+4
@@ -1,3 +1,5 @@
1+{-# language StandaloneKindSignatures #-}
2+
1module Rel8.Type.JSONBEncoded ( JSONBEncoded(..) ) where
3module Rel8.Type.JSONBEncoded ( JSONBEncoded(..) ) where
2
4
3-- aeson
5-- aeson
@@ -6,6 +8,7 @@ import Data.Aeson.Types ( parseEither )
6
8
7-- base
9-- base
8import Data.Bifunctor ( first )
10import Data.Bifunctor ( first )
11+import Data.Kind ( Type )
9import Prelude
12import Prelude
10
13
11-- hasql
14-- hasql
@@ -20,6 +23,7 @@ import Data.Text ( pack )
20
23
21
24
22-- | Like 'Rel8.JSONEncoded', but works for @jsonb@ columns.
25-- | Like 'Rel8.JSONEncoded', but works for @jsonb@ columns.
26+type JSONBEncoded :: Type -> Type
23newtype JSONBEncoded a = JSONBEncoded { fromJSONBEncoded :: a }
27newtype JSONBEncoded a = JSONBEncoded { fromJSONBEncoded :: a }
24
28
25
29
src/Rel8/Type/JSONEncoded.hs+4
@@ -1,3 +1,5 @@
1+{-# language StandaloneKindSignatures #-}
2+
1module Rel8.Type.JSONEncoded ( JSONEncoded(..) ) where
3module Rel8.Type.JSONEncoded ( JSONEncoded(..) ) where
2
4
3-- aeson
5-- aeson
@@ -5,6 +7,7 @@ import Data.Aeson ( FromJSON, ToJSON, parseJSON, toJSON )
5import Data.Aeson.Types ( parseEither )
7import Data.Aeson.Types ( parseEither )
6
8
7-- base
9-- base
10+import Data.Kind ( Type )
8import Prelude
11import Prelude
9
12
10-- rel8
13-- rel8
@@ -15,6 +18,7 @@ import Rel8.Type.Information ( parseTypeInformation )
15-- | A deriving-via helper type for column types that store a Haskell value
18-- | A deriving-via helper type for column types that store a Haskell value
16-- using a JSON encoding described by @aeson@'s 'ToJSON' and 'FromJSON' type
19-- using a JSON encoding described by @aeson@'s 'ToJSON' and 'FromJSON' type
17-- classes.
20-- classes.
21+type JSONEncoded :: Type -> Type
18newtype JSONEncoded a = JSONEncoded { fromJSONEncoded :: a }
22newtype JSONEncoded a = JSONEncoded { fromJSONEncoded :: a }
19
23
20
24
src/Rel8/Type/Monoid.hs+2−2
@@ -27,7 +27,7 @@ import Data.CaseInsensitive ( CI )
27import {-# SOURCE #-} Rel8.Expr ( Expr )
27import {-# SOURCE #-} Rel8.Expr ( Expr )
28import Rel8.Expr.Array ( sempty )
28import Rel8.Expr.Array ( sempty )
29import Rel8.Expr.Serialize ( litExpr )
29import Rel8.Expr.Serialize ( litExpr )
30−import Rel8.Schema.Null ( Sql, nullable )
30+import Rel8.Schema.Null ( Sql )
31import Rel8.Type ( DBType, typeInformation )
31import Rel8.Type ( DBType, typeInformation )
32import Rel8.Type.Semigroup ( DBSemigroup )
32import Rel8.Type.Semigroup ( DBSemigroup )
33
33
@@ -48,7 +48,7 @@ class DBSemigroup a => DBMonoid a where
48
48
49
49
50instance Sql DBType a => DBMonoid [a] where
50instance Sql DBType a => DBMonoid [a] where
51− memptyExpr = sempty nullable typeInformation
51+ memptyExpr = sempty typeInformation
52
52
53
53
54instance DBMonoid CalendarDiffTime where
54instance DBMonoid CalendarDiffTime where
src/Rel8/Type/Num.hs+11−2
@@ -7,7 +7,7 @@
7{-# language UndecidableInstances #-}
7{-# language UndecidableInstances #-}
8
8
9module Rel8.Type.Num
9module Rel8.Type.Num
10− ( DBNum, DBIntegral, DBFractional
10+ ( DBNum, DBIntegral, DBFractional, DBFloating
11 )
11 )
12where
12where
13
13
@@ -18,6 +18,7 @@ import Prelude
18
18
19-- rel8
19-- rel8
20import Rel8.Type ( DBType )
20import Rel8.Type ( DBType )
21+import Rel8.Type.Ord ( DBOrd )
21
22
22-- scientific
23-- scientific
23import Data.Scientific ( Scientific )
24import Data.Scientific ( Scientific )
@@ -39,14 +40,22 @@ instance DBNum Scientific
39-- expressions. This is a Rel8 concept, and allows us to provide
40-- expressions. This is a Rel8 concept, and allows us to provide
40-- 'fromIntegral'.
41-- 'fromIntegral'.
41type DBIntegral :: Type -> Constraint
42type DBIntegral :: Type -> Constraint
42−class DBNum a => DBIntegral a
43+class (DBNum a, DBOrd a) => DBIntegral a
43instance DBIntegral Int16
44instance DBIntegral Int16
44instance DBIntegral Int32
45instance DBIntegral Int32
45instance DBIntegral Int64
46instance DBIntegral Int64
46
47
47
48
48-- | The class of database types that support the @/@ operator.
49-- | The class of database types that support the @/@ operator.
50+type DBFractional :: Type -> Constraint
49class DBNum a => DBFractional a
51class DBNum a => DBFractional a
50instance DBFractional Float
52instance DBFractional Float
51instance DBFractional Double
53instance DBFractional Double
52instance DBFractional Scientific
54instance DBFractional Scientific
55+
56+
57+-- | The class of database types that support the @/@ operator.
58+type DBFloating :: Type -> Constraint
59+class DBFractional a => DBFloating a
60+instance DBFloating Float
61+instance DBFloating Double
src/Rel8/Type/Ord.hs−2
@@ -75,7 +75,6 @@ instance Sql DBOrd a => DBOrd (NonEmpty a)
75-- | The class of database types that support the @max@ aggregation function.
75-- | The class of database types that support the @max@ aggregation function.
76type DBMax :: Type -> Constraint
76type DBMax :: Type -> Constraint
77class DBOrd a => DBMax a
77class DBOrd a => DBMax a
78−instance DBMax Bool
79instance DBMax Char
78instance DBMax Char
80instance DBMax Int16
79instance DBMax Int16
81instance DBMax Int32
80instance DBMax Int32
@@ -101,7 +100,6 @@ instance Sql DBMax a => DBMax (NonEmpty a)
101-- | The class of database types that support the @min@ aggregation function.
100-- | The class of database types that support the @min@ aggregation function.
102type DBMin :: Type -> Constraint
101type DBMin :: Type -> Constraint
103class DBOrd a => DBMin a
102class DBOrd a => DBMin a
104−instance DBMin Bool
105instance DBMin Char
103instance DBMin Char
106instance DBMin Int16
104instance DBMin Int16
107instance DBMin Int32
105instance DBMin Int32
src/Rel8/Type/ReadShow.hs+3
@@ -1,10 +1,12 @@
1{-# language ScopedTypeVariables #-}
1{-# language ScopedTypeVariables #-}
2+{-# language StandaloneKindSignatures #-}
2{-# language TypeApplications #-}
3{-# language TypeApplications #-}
3{-# language ViewPatterns #-}
4{-# language ViewPatterns #-}
4
5
5module Rel8.Type.ReadShow ( ReadShow(..) ) where
6module Rel8.Type.ReadShow ( ReadShow(..) ) where
6
7
7-- base
8-- base
9+import Data.Kind ( Type )
8import Data.Proxy ( Proxy( Proxy ) )
10import Data.Proxy ( Proxy( Proxy ) )
9import Data.Typeable ( Typeable, typeRep )
11import Data.Typeable ( Typeable, typeRep )
10import Prelude
12import Prelude
@@ -20,6 +22,7 @@ import qualified Data.Text as Text
20
22
21-- | A deriving-via helper type for column types that store a Haskell value
23-- | A deriving-via helper type for column types that store a Haskell value
22-- using a Haskell's 'Read' and 'Show' type classes.
24-- using a Haskell's 'Read' and 'Show' type classes.
25+type ReadShow :: Type -> Type
23newtype ReadShow a = ReadShow { fromReadShow :: a }
26newtype ReadShow a = ReadShow { fromReadShow :: a }
24
27
25
28
src/Rel8/Type/Semigroup.hs+4−2
@@ -1,3 +1,4 @@
1+{-# language BlockArguments #-}
1{-# language DataKinds #-}
2{-# language DataKinds #-}
2{-# language FlexibleContexts #-}
3{-# language FlexibleContexts #-}
3{-# language FlexibleInstances #-}
4{-# language FlexibleInstances #-}
@@ -28,6 +29,7 @@ import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
28
29
29-- rel8
30-- rel8
30import {-# SOURCE #-} Rel8.Expr ( Expr )
31import {-# SOURCE #-} Rel8.Expr ( Expr )
32+import Rel8.Expr.Array ( sappend, sappend1 )
31import Rel8.Expr.Opaleye ( zipPrimExprsWith )
33import Rel8.Expr.Opaleye ( zipPrimExprsWith )
32import Rel8.Schema.Null ( Sql )
34import Rel8.Schema.Null ( Sql )
33import Rel8.Type ( DBType )
35import Rel8.Type ( DBType )
@@ -50,11 +52,11 @@ class DBType a => DBSemigroup a where
50
52
51
53
52instance Sql DBType a => DBSemigroup [a] where
54instance Sql DBType a => DBSemigroup [a] where
53− (<>.) = zipPrimExprsWith (Opaleye.BinExpr (Opaleye.:||))
55+ (<>.) = sappend
54
56
55
57
56instance Sql DBType a => DBSemigroup (NonEmpty a) where
58instance Sql DBType a => DBSemigroup (NonEmpty a) where
57− (<>.) = zipPrimExprsWith (Opaleye.BinExpr (Opaleye.:||))
59+ (<>.) = sappend1
58
60
59
61
60instance DBSemigroup CalendarDiffTime where
62instance DBSemigroup CalendarDiffTime where
src/Rel8/Type/Tag.hs+14−1
@@ -1,11 +1,13 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2{-# language DeriveAnyClass #-}
2{-# language DeriveAnyClass #-}
3{-# language DerivingVia #-}
3{-# language DerivingVia #-}
4+{-# language GeneralizedNewtypeDeriving #-}
4{-# language StandaloneKindSignatures #-}
5{-# language StandaloneKindSignatures #-}
5
6
6module Rel8.Type.Tag
7module Rel8.Type.Tag
7 ( EitherTag( IsLeft, IsRight ), isLeft, isRight
8 ( EitherTag( IsLeft, IsRight ), isLeft, isRight
8 , MaybeTag( IsJust )
9 , MaybeTag( IsJust )
10+ , Tag( Tag )
9 )
11 )
10where
12where
11
13
@@ -19,7 +21,7 @@ import Prelude
19import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
21import qualified Opaleye.Internal.HaskellDB.PrimQuery as Opaleye
20
22
21-- rel8
23-- rel8
22−import {-# SOURCE #-} Rel8.Expr ( Expr )
24+import Rel8.Expr ( Expr )
23import Rel8.Expr.Eq ( (==.) )
25import Rel8.Expr.Eq ( (==.) )
24import Rel8.Expr.Opaleye ( zipPrimExprsWith )
26import Rel8.Expr.Opaleye ( zipPrimExprsWith )
25import Rel8.Expr.Serialize ( litExpr )
27import Rel8.Expr.Serialize ( litExpr )
@@ -30,6 +32,9 @@ import Rel8.Type.Monoid ( DBMonoid, memptyExpr )
30import Rel8.Type.Ord ( DBOrd )
32import Rel8.Type.Ord ( DBOrd )
31import Rel8.Type.Semigroup ( DBSemigroup, (<>.) )
33import Rel8.Type.Semigroup ( DBSemigroup, (<>.) )
32
34
35+-- text
36+import Data.Text ( Text )
37+
33
38
34type EitherTag :: Type
39type EitherTag :: Type
35data EitherTag = IsLeft | IsRight
40data EitherTag = IsLeft | IsRight
@@ -83,3 +88,11 @@ instance DBSemigroup MaybeTag where
83
88
84instance DBMonoid MaybeTag where
89instance DBMonoid MaybeTag where
85 memptyExpr = litExpr mempty
90 memptyExpr = litExpr mempty
91+
92+
93+type Tag :: Type
94+newtype Tag = Tag Text
95+ deriving newtype
96+ ( Eq, Ord, Read, Show
97+ , DBType, DBEq, DBOrd
98+ )
src/Rel8/Window.hsnew file+97
@@ -0,0 +1,97 @@
1+{-# language DerivingVia #-}
2+{-# language FlexibleContexts #-}
3+{-# language GeneralizedNewtypeDeriving #-}
4+{-# language ScopedTypeVariables #-}
5+{-# language StandaloneKindSignatures #-}
6+{-# language TypeApplications #-}
7+
8+module Rel8.Window
9+ ( Window(..)
10+ , Partition
11+ , over
12+ , partitionBy
13+ , orderPartitionBy
14+ )
15+where
16+
17+-- base
18+import Data.Functor.Const ( Const( Const ), getConst )
19+import Data.Functor.Contravariant ( Contravariant, contramap )
20+import Data.Kind ( Type )
21+import Prelude
22+
23+-- opaleye
24+import qualified Opaleye.Internal.Window as Opaleye
25+import qualified Opaleye.Internal.PackMap as Opaleye
26+
27+-- profunctors
28+import Data.Profunctor ( Profunctor )
29+
30+-- product-profunctors
31+import Data.Profunctor.Product ( ProductProfunctor, (****), purePP )
32+
33+-- rel8
34+import Rel8.Expr.Opaleye ( toColumn, toPrimExpr )
35+import Rel8.Order( Order( Order ) )
36+import Rel8.Schema.HTable ( hfield, htabulateA )
37+import Rel8.Table ( Columns, toColumns )
38+import Rel8.Table.Eq ( EqTable )
39+
40+-- semigroupoids
41+import Data.Functor.Apply ( Apply, WrappedApplicative(..) )
42+
43+
44+-- | 'Window' is an applicative functor that represents expressions that
45+-- contain
46+-- [window functions](https://www.postgresql.org/docs/current/tutorial-window.html).
47+-- 'Rel8.Query.Window.window' can be used to
48+-- evaluate these expressions over a particular query.
49+type Window :: Type -> Type -> Type
50+newtype Window a b = Window (Opaleye.Windows a b)
51+ deriving newtype (Profunctor)
52+ deriving newtype (Functor, Applicative)
53+ deriving (Apply) via (WrappedApplicative (Window a))
54+
55+
56+instance ProductProfunctor Window where
57+ purePP = pure
58+ (****) = (<*>)
59+
60+
61+-- | In PostgreSQL, window functions must specify the \"window\" or
62+-- \"partition\" over which they operate. The syntax for this looks like:
63+-- @SUM(salary) OVER (PARTITION BY department)@. The Rel8 type 'Partition'
64+-- represents everything that comes after @OVER@.
65+--
66+-- 'Partition' is a 'Monoid', so 'Window's created with 'partitionBy' and
67+-- 'orderWindowBy' can be combined using '<>'.
68+type Partition :: Type -> Type
69+newtype Partition a = Partition (Opaleye.Window a)
70+ deriving newtype (Contravariant, Semigroup, Monoid)
71+
72+
73+-- | 'over' adds a 'Partition' to a 'Window' expression.
74+--
75+-- @@@
76+-- 'Rel8.Table.Window.cumulative' ('Rel8.Expr.Aggregate.sum' . salary) `over` 'partitionBy' department <> 'orderPartitionBy' (salary >$< 'Rel8.desc')
77+-- @@@
78+over :: Window a b -> Partition a -> Window a b
79+over (Window (Opaleye.Windows (Opaleye.PackMap w))) (Partition p) =
80+ Window $ Opaleye.Windows $ Opaleye.PackMap $ \f ->
81+ w (\(o, p') -> f (o, p' <> p))
82+infixl 1 `over`
83+
84+
85+-- | Restricts a window function to operate only the group of rows that share
86+-- the same value(s) for the given expression(s).
87+partitionBy :: forall b a. EqTable b => (a -> b) -> Partition a
88+partitionBy f =
89+ Partition $ contramap (toColumns . f) $ getConst $
90+ htabulateA @(Columns b) $ \field ->
91+ Const $ Opaleye.partitionBy (toColumn . toPrimExpr . (`hfield` field))
92+
93+
94+-- | Controls the order in which rows are processed by window functions. This
95+-- does not need to match the ordering of the overall query.
96+orderPartitionBy :: Order a -> Partition a
97+orderPartitionBy (Order ordering) = Partition $ Opaleye.orderPartitionBy ordering
tests/Main.hs+323−159
@@ -1,12 +1,11 @@
1+{-# language BangPatterns #-}
1{-# language BlockArguments #-}
2{-# language BlockArguments #-}
2−{-# language DataKinds #-}
3{-# language DeriveAnyClass #-}
3{-# language DeriveAnyClass #-}
4{-# language DeriveGeneric #-}
4{-# language DeriveGeneric #-}
5{-# language DerivingStrategies #-}
5{-# language DerivingStrategies #-}
6−{-# language DisambiguateRecordFields #-}
7{-# language FlexibleContexts #-}
6{-# language FlexibleContexts #-}
8{-# language FlexibleInstances #-}
7{-# language FlexibleInstances #-}
9−{-# language GADTs #-}
8+{-# language MonoLocalBinds #-}
10{-# language NamedFieldPuns #-}
9{-# language NamedFieldPuns #-}
11{-# language OverloadedStrings #-}
10{-# language OverloadedStrings #-}
12{-# language RecordWildCards #-}
11{-# language RecordWildCards #-}
@@ -14,17 +13,15 @@
14{-# language StandaloneDeriving #-}
13{-# language StandaloneDeriving #-}
15{-# language TypeApplications #-}
14{-# language TypeApplications #-}
16
15
17−{-# options_ghc -fno-warn-redundant-constraints #-}
18−
19module Main
16module Main
20 ( main
17 ( main
21 )
18 )
22where
19where
23
20
24-- base
21-- base
25−import Control.Applicative ( liftA2, liftA3 )
22+import Control.Applicative ( empty, liftA2, liftA3 )
26−import Control.Monad (void)
23+import Control.Exception ( bracket, throwIO )
27−import Control.Monad.IO.Class ( MonadIO, liftIO )
24+import Control.Monad ( (>=>), void )
28import Data.Bifunctor ( bimap )
25import Data.Bifunctor ( bimap )
29import Data.Foldable ( for_ )
26import Data.Foldable ( for_ )
30import Data.Int ( Int32, Int64 )
27import Data.Int ( Int32, Int64 )
@@ -38,25 +35,27 @@ import GHC.Generics ( Generic )
38import qualified Data.ByteString.Lazy
35import qualified Data.ByteString.Lazy
39
36
40-- case-insensitive
37-- case-insensitive
41−import Data.CaseInsensitive (mk)
38+import Data.CaseInsensitive ( mk )
42
39
43-- containers
40-- containers
41+import Data.Containers.ListUtils ( nubOrdOn )
44import qualified Data.Map.Strict as Map
42import qualified Data.Map.Strict as Map
45
43
46-- hasql
44-- hasql
47−import Hasql.Connection ( Connection, acquire, release )
45+import Hasql.Connection ( Connection, acquire, release )
48import Hasql.Session ( sql, run )
46import Hasql.Session ( sql, run )
49
47
48+-- hasql-transaction
49+import Hasql.Transaction ( Transaction, condemn, statement )
50+import qualified Hasql.Transaction.Sessions as Hasql
51+
50-- hedgehog
52-- hedgehog
51import Hedgehog ( property, (===), forAll, cover, diff, evalM, PropertyT, TestT, test, Gen )
53import Hedgehog ( property, (===), forAll, cover, diff, evalM, PropertyT, TestT, test, Gen )
52import qualified Hedgehog.Gen as Gen
54import qualified Hedgehog.Gen as Gen
53import qualified Hedgehog.Range as Range
55import qualified Hedgehog.Range as Range
54
56
55−-- lifted-base
57+-- mmorph
56−import Control.Exception.Lifted ( bracket, throwIO, bracket_ )
58+import Control.Monad.Morph ( hoist )
57−
58−-- monad-control
59−import Control.Monad.Trans.Control ( MonadBaseControl )
60
59
61-- rel8
60-- rel8
62import Rel8 ( Result )
61import Rel8 ( Result )
@@ -72,12 +71,16 @@ import Test.Tasty
72import Test.Tasty.Hedgehog ( testProperty )
71import Test.Tasty.Hedgehog ( testProperty )
73
72
74-- text
73-- text
75−import Data.Text (Text, pack)
74+import Data.Text ( Text, pack, unpack )
76import qualified Data.Text.Lazy
75import qualified Data.Text.Lazy
76+import Data.Text.Encoding ( decodeUtf8 )
77
77
78-- time
78-- time
79import Data.Time
79import Data.Time
80
80
81+-- transformers
82+import Control.Monad.Trans.Class ( lift )
83+
81-- tmp-postgres
84-- tmp-postgres
82import qualified Database.Postgres.Temp as TmpPostgres
85import qualified Database.Postgres.Temp as TmpPostgres
83
86
@@ -113,14 +116,17 @@ tests =
113 , testCatMaybeTable getTestDatabase
116 , testCatMaybeTable getTestDatabase
114 , testCatMaybe getTestDatabase
117 , testCatMaybe getTestDatabase
115 , testMaybeTable getTestDatabase
118 , testMaybeTable getTestDatabase
119+ , testAggregateMaybeTable getTestDatabase
116 , testNestedTables getTestDatabase
120 , testNestedTables getTestDatabase
117 , testMaybeTableApplicative getTestDatabase
121 , testMaybeTableApplicative getTestDatabase
118 , testLogicalFixities getTestDatabase
122 , testLogicalFixities getTestDatabase
119 , testUpdate getTestDatabase
123 , testUpdate getTestDatabase
120 , testDelete getTestDatabase
124 , testDelete getTestDatabase
125+ , testUpsert getTestDatabase
121 , testSelectNestedPairs getTestDatabase
126 , testSelectNestedPairs getTestDatabase
122 , testSelectArray getTestDatabase
127 , testSelectArray getTestDatabase
123 , testNestedMaybeTable getTestDatabase
128 , testNestedMaybeTable getTestDatabase
129+ , testEvaluate getTestDatabase
124 ]
130 ]
125
131
126 where
132 where
@@ -132,25 +138,29 @@ tests =
132 flip run conn do
138 flip run conn do
133 sql "CREATE EXTENSION citext"
139 sql "CREATE EXTENSION citext"
134 sql "CREATE TABLE test_table ( column1 text not null, column2 bool not null )"
140 sql "CREATE TABLE test_table ( column1 text not null, column2 bool not null )"
141+ sql "CREATE TABLE unique_table ( \"key\" text not null unique, \"value\" text not null )"
142+ sql "CREATE SEQUENCE test_seq"
135
143
136 return db
144 return db
137
145
138 stopTestDatabase = TmpPostgres.stop
146 stopTestDatabase = TmpPostgres.stop
139
147
140
148
149+connect :: TmpPostgres.DB -> IO Connection
150+connect = acquire . TmpPostgres.toConnectionString >=> either (maybe empty (fail . unpack . decodeUtf8)) pure
151+
152+
141databasePropertyTest
153databasePropertyTest
142 :: TestName
154 :: TestName
143− -> (((Connection -> TestT IO ()) -> PropertyT IO ()) -> PropertyT IO ())
155+ -> ((TestT Transaction () -> PropertyT IO ()) -> PropertyT IO ())
144 -> IO TmpPostgres.DB -> TestTree
156 -> IO TmpPostgres.DB -> TestTree
145databasePropertyTest testName f getTestDatabase =
157databasePropertyTest testName f getTestDatabase =
146− withResource connect release $ \c ->
158+ withResource (connect =<< getTestDatabase) release $ \c ->
147 testProperty testName $ property do
159 testProperty testName $ property do
148− connection <- liftIO c
160+ connection <- lift c
149− f \g -> test $ rollingBack connection $ g connection
161+ f $ test . hoist \m -> do
150−
162+ e <- run (Hasql.transaction Hasql.Serializable Hasql.Write (m <* condemn)) connection
151− where
163+ either throwIO pure e
152−
153− connect = either (error . show) return =<< acquire . TmpPostgres.toConnectionString =<< getTestDatabase
154
164
155
165
156data TestTable f = TestTable
166data TestTable f = TestTable
@@ -182,18 +192,17 @@ testSelectTestTable :: IO TmpPostgres.DB -> TestTree
182testSelectTestTable = databasePropertyTest "Can SELECT TestTable" \transaction -> do
192testSelectTestTable = databasePropertyTest "Can SELECT TestTable" \transaction -> do
183 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
193 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
184
194
185− transaction \connection -> do
195+ transaction do
186− void do
196+ selected <- lift do
187− liftIO $ Rel8.insert connection
197+ statement () $ Rel8.insert Rel8.Insert
188− Rel8.Insert
198+ { into = testTableSchema
189− { into = testTableSchema
199+ , rows = Rel8.values $ map Rel8.lit rows
190− , rows = map (Rel8.toInsert . Rel8.lit) rows
200+ , onConflict = Rel8.DoNothing
191− , onConflict = Rel8.DoNothing
201+ , returning = pure ()
192− , returning = Rel8.NumberOfRowsAffected
202+ }
193− }
194
203
195− selected <- liftIO $ Rel8.select connection do
204+ statement () $ Rel8.select do
196− Rel8.each testTableSchema
205+ Rel8.each testTableSchema
197
206
198 sort selected === sort rows
207 sort selected === sort rows
199
208
@@ -210,11 +219,12 @@ testWhere_ = databasePropertyTest "WHERE (Rel8.where_)" \transaction -> do
210
219
211 let expected = filter (\t -> testTableColumn2 t == magicBool) rows
220 let expected = filter (\t -> testTableColumn2 t == magicBool) rows
212
221
213− transaction \connection -> do
222+ transaction do
214− selected <- liftIO $ Rel8.select connection do
223+ selected <- lift do
215− t <- Rel8.values $ Rel8.lit <$> rows
224+ statement () $ Rel8.select do
216− Rel8.where_ $ testTableColumn2 t Rel8.==. Rel8.lit magicBool
225+ t <- Rel8.values $ Rel8.lit <$> rows
217− return t
226+ Rel8.where_ $ testTableColumn2 t Rel8.==. Rel8.lit magicBool
227+ return t
218
228
219 sort selected === sort expected
229 sort selected === sort expected
220
230
@@ -227,11 +237,12 @@ testFilter :: IO TmpPostgres.DB -> TestTree
227testFilter = databasePropertyTest "filter" \transaction -> do
237testFilter = databasePropertyTest "filter" \transaction -> do
228 rows <- forAll $ Gen.list (Range.linear 1 10) genTestTable
238 rows <- forAll $ Gen.list (Range.linear 1 10) genTestTable
229
239
230− transaction \connection -> do
240+ transaction do
231 let expected = filter testTableColumn2 rows
241 let expected = filter testTableColumn2 rows
232
242
233− selected <- liftIO $ Rel8.select connection
243+ selected <- lift do
234− $ Rel8.filter testTableColumn2 =<< Rel8.values (Rel8.lit <$> rows)
244+ statement () $ Rel8.select do
245+ Rel8.filter testTableColumn2 =<< Rel8.values (Rel8.lit <$> rows)
235
246
236 sort selected === sort expected
247 sort selected === sort expected
237
248
@@ -246,9 +257,10 @@ testLimit = databasePropertyTest "LIMIT (Rel8.limit)" \transaction -> do
246
257
247 n <- forAll $ Gen.integral (Range.linear 0 10)
258 n <- forAll $ Gen.integral (Range.linear 0 10)
248
259
249− transaction \connection -> do
260+ transaction do
250− selected <- liftIO $ Rel8.select connection do
261+ selected <- lift do
251− Rel8.limit n $ Rel8.values (Rel8.lit <$> rows)
262+ statement () $ Rel8.select do
263+ Rel8.limit n $ Rel8.values (Rel8.lit <$> rows)
252
264
253 diff (length selected) (<=) (fromIntegral n)
265 diff (length selected) (<=) (fromIntegral n)
254
266
@@ -266,9 +278,10 @@ testUnion = databasePropertyTest "UNION (Rel8.union)" \transaction -> evalM do
266 left <- forAll $ Gen.list (Range.linear 0 10) genTestTable
278 left <- forAll $ Gen.list (Range.linear 0 10) genTestTable
267 right <- forAll $ Gen.list (Range.linear 0 10) genTestTable
279 right <- forAll $ Gen.list (Range.linear 0 10) genTestTable
268
280
269− transaction \connection -> do
281+ transaction do
270− selected <- liftIO $ Rel8.select connection do
282+ selected <- lift do
271− Rel8.values (Rel8.lit <$> nub left) `Rel8.union` Rel8.values (Rel8.lit <$> nub right)
283+ statement () $ Rel8.select do
284+ Rel8.values (Rel8.lit <$> nub left) `Rel8.union` Rel8.values (Rel8.lit <$> nub right)
272
285
273 sort selected === sort (nub (left ++ right))
286 sort selected === sort (nub (left ++ right))
274
287
@@ -277,9 +290,11 @@ testDistinct :: IO TmpPostgres.DB -> TestTree
277testDistinct = databasePropertyTest "DISTINCT (Rel8.distinct)" \transaction -> do
290testDistinct = databasePropertyTest "DISTINCT (Rel8.distinct)" \transaction -> do
278 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
291 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
279
292
280− transaction \connection -> do
293+ transaction do
281− selected <- liftIO $ Rel8.select connection $ Rel8.distinct do
294+ selected <- lift do
282− Rel8.values (Rel8.lit <$> rows)
295+ statement () $ Rel8.select do
296+ Rel8.distinct do
297+ Rel8.values (Rel8.lit <$> rows)
283
298
284 sort selected === nub (sort rows)
299 sort selected === nub (sort rows)
285
300
@@ -292,8 +307,10 @@ testExists :: IO TmpPostgres.DB -> TestTree
292testExists = databasePropertyTest "EXISTS (Rel8.exists)" \transaction -> do
307testExists = databasePropertyTest "EXISTS (Rel8.exists)" \transaction -> do
293 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
308 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
294
309
295− transaction \connection -> do
310+ transaction do
296− exists <- liftIO $ Rel8.select connection $ Rel8.exists $ Rel8.values $ Rel8.lit <$> rows
311+ exists <- lift do
312+ statement () $ Rel8.select do
313+ Rel8.exists $ Rel8.values $ Rel8.lit <$> rows
297
314
298 case rows of
315 case rows of
299 [] -> exists === [False]
316 [] -> exists === [False]
@@ -304,9 +321,10 @@ testOptional :: IO TmpPostgres.DB -> TestTree
304testOptional = databasePropertyTest "Rel8.optional" \transaction -> do
321testOptional = databasePropertyTest "Rel8.optional" \transaction -> do
305 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
322 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
306
323
307− transaction \connection -> do
324+ transaction do
308− selected <- liftIO $ Rel8.select connection do
325+ selected <- lift do
309− Rel8.optional $ Rel8.values (Rel8.lit <$> rows)
326+ statement () $ Rel8.select do
327+ Rel8.optional $ Rel8.values (Rel8.lit <$> rows)
310
328
311 case rows of
329 case rows of
312 [] -> selected === [Nothing]
330 [] -> selected === [Nothing]
@@ -317,9 +335,10 @@ testAnd :: IO TmpPostgres.DB -> TestTree
317testAnd = databasePropertyTest "AND (&&.)" \transaction -> do
335testAnd = databasePropertyTest "AND (&&.)" \transaction -> do
318 (x, y) <- forAll $ liftA2 (,) Gen.bool Gen.bool
336 (x, y) <- forAll $ liftA2 (,) Gen.bool Gen.bool
319
337
320− transaction \connection -> do
338+ transaction do
321− [result] <- liftIO $ Rel8.select connection $ pure $
339+ [result] <- lift do
322− Rel8.lit x Rel8.&&. Rel8.lit y
340+ statement () $ Rel8.select do
341+ pure $ Rel8.lit x Rel8.&&. Rel8.lit y
323
342
324 result === (x && y)
343 result === (x && y)
325
344
@@ -328,9 +347,10 @@ testOr :: IO TmpPostgres.DB -> TestTree
328testOr = databasePropertyTest "OR (||.)" \transaction -> do
347testOr = databasePropertyTest "OR (||.)" \transaction -> do
329 (x, y) <- forAll $ liftA2 (,) Gen.bool Gen.bool
348 (x, y) <- forAll $ liftA2 (,) Gen.bool Gen.bool
330
349
331− transaction \connection -> do
350+ transaction do
332− [result] <- liftIO $ Rel8.select connection $ pure $
351+ [result] <- lift do
333− Rel8.lit x Rel8.||. Rel8.lit y
352+ statement () $ Rel8.select $ pure $
353+ Rel8.lit x Rel8.||. Rel8.lit y
334
354
335 result === (x || y)
355 result === (x || y)
336
356
@@ -339,9 +359,10 @@ testLogicalFixities :: IO TmpPostgres.DB -> TestTree
339testLogicalFixities = databasePropertyTest "Logical operator fixities" \transaction -> do
359testLogicalFixities = databasePropertyTest "Logical operator fixities" \transaction -> do
340 (u, v, w, x) <- forAll $ (,,,) <$> Gen.bool <*> Gen.bool <*> Gen.bool <*> Gen.bool
360 (u, v, w, x) <- forAll $ (,,,) <$> Gen.bool <*> Gen.bool <*> Gen.bool <*> Gen.bool
341
361
342− transaction \connection -> do
362+ transaction do
343− [result] <- liftIO $ Rel8.select connection $ pure $
363+ [result] <- lift do
344− Rel8.lit u Rel8.||. Rel8.lit v Rel8.&&. Rel8.lit w Rel8.==. Rel8.lit x
364+ statement () $ Rel8.select do
365+ pure $ Rel8.lit u Rel8.||. Rel8.lit v Rel8.&&. Rel8.lit w Rel8.==. Rel8.lit x
345
366
346 result === (u || v && w == x)
367 result === (u || v && w == x)
347
368
@@ -350,9 +371,10 @@ testNot :: IO TmpPostgres.DB -> TestTree
350testNot = databasePropertyTest "NOT (not_)" \transaction -> do
371testNot = databasePropertyTest "NOT (not_)" \transaction -> do
351 x <- forAll Gen.bool
372 x <- forAll Gen.bool
352
373
353− transaction \connection -> do
374+ transaction do
354− [result] <- liftIO $ Rel8.select connection $ pure $
375+ [result] <- lift do
355− Rel8.not_ $ Rel8.lit x
376+ statement () $ Rel8.select do
377+ pure $ Rel8.not_ $ Rel8.lit x
356
378
357 result === not x
379 result === not x
358
380
@@ -361,9 +383,10 @@ testBool :: IO TmpPostgres.DB -> TestTree
361testBool = databasePropertyTest "ifThenElse_" \transaction -> do
383testBool = databasePropertyTest "ifThenElse_" \transaction -> do
362 (x, y, z) <- forAll $ liftA3 (,,) Gen.bool Gen.bool Gen.bool
384 (x, y, z) <- forAll $ liftA3 (,,) Gen.bool Gen.bool Gen.bool
363
385
364− transaction \connection -> do
386+ transaction do
365− [result] <- liftIO $ Rel8.select connection $ pure $
387+ [result] <- lift do
366− Rel8.bool (Rel8.lit z) (Rel8.lit y) (Rel8.lit x)
388+ statement () $ Rel8.select do
389+ pure $ Rel8.bool (Rel8.lit z) (Rel8.lit y) (Rel8.lit x)
367
390
368 result === if x then y else z
391 result === if x then y else z
369
392
@@ -375,9 +398,10 @@ testAp = databasePropertyTest "Cartesian product (<*>)" \transaction -> do
375 (Gen.list (Range.linear 1 10) genTestTable)
398 (Gen.list (Range.linear 1 10) genTestTable)
376 (Gen.list (Range.linear 1 10) genTestTable)
399 (Gen.list (Range.linear 1 10) genTestTable)
377
400
378− transaction \connection -> do
401+ transaction do
379− result <- liftIO $ Rel8.select connection $ do
402+ result <- lift do
380− liftA2 (,) (Rel8.values (Rel8.lit <$> rows1)) (Rel8.values (Rel8.lit <$> rows2))
403+ statement () $ Rel8.select do
404+ liftA2 (,) (Rel8.values (Rel8.lit <$> rows1)) (Rel8.values (Rel8.lit <$> rows2))
381
405
382 sort result === sort (liftA2 (,) rows1 rows2)
406 sort result === sort (liftA2 (,) rows1 rows2)
383
407
@@ -406,21 +430,22 @@ testDBType getTestDatabase = testGroup "DBType instances"
406 where
430 where
407 dbTypeTest :: (Eq a, Show a, Rel8.DBType a) => TestName -> Gen a -> TestTree
431 dbTypeTest :: (Eq a, Show a, Rel8.DBType a) => TestName -> Gen a -> TestTree
408 dbTypeTest name generator = testGroup name
432 dbTypeTest name generator = testGroup name
409− [ databasePropertyTest name (t (==) generator) getTestDatabase
433+ [ databasePropertyTest name (t generator) getTestDatabase
410− , databasePropertyTest ("Maybe " <> name) (t (==) (Gen.maybe generator)) getTestDatabase
434+ , databasePropertyTest ("Maybe " <> name) (t (Gen.maybe generator)) getTestDatabase
411 ]
435 ]
412
436
413− t :: forall a b. (Show a, Rel8.Sql Rel8.DBType a)
437+ t :: forall a b. (Eq a, Show a, Rel8.Sql Rel8.DBType a)
414− => (a -> a -> Bool)
438+ => Gen a
415− -> Gen a
439+ -> (TestT Transaction () -> PropertyT IO b)
416− -> ((Connection -> TestT IO ()) -> PropertyT IO b)
417 -> PropertyT IO b
440 -> PropertyT IO b
418− t eq generator transaction = do
441+ t generator transaction = do
419 x <- forAll generator
442 x <- forAll generator
420
443
421− transaction \connection -> do
444+ transaction do
422− [res] <- liftIO $ Rel8.select connection $ pure (Rel8.litExpr x)
445+ [res] <- lift do
423− diff res eq x
446+ statement () $ Rel8.select do
447+ pure (Rel8.litExpr x)
448+ diff res (==) x
424
449
425 genDay :: Gen Day
450 genDay :: Gen Day
426 genDay = do
451 genDay = do
@@ -462,39 +487,38 @@ testDBEq getTestDatabase = testGroup "DBEq instances"
462
487
463 t :: forall a. (Eq a, Show a, Rel8.Sql Rel8.DBEq a)
488 t :: forall a. (Eq a, Show a, Rel8.Sql Rel8.DBEq a)
464 => Gen a
489 => Gen a
465− -> ((Connection -> TestT IO ()) -> PropertyT IO ())
490+ -> (TestT Transaction () -> PropertyT IO ())
466 -> PropertyT IO ()
491 -> PropertyT IO ()
467 t generator transaction = do
492 t generator transaction = do
468 (x, y) <- forAll (liftA2 (,) generator generator)
493 (x, y) <- forAll (liftA2 (,) generator generator)
469
494
470− transaction \connection -> do
495+ transaction do
471− [res] <- liftIO $ Rel8.select connection $ pure $ Rel8.litExpr x Rel8.==. Rel8.litExpr y
496+ [res] <- lift do
497+ statement () $ Rel8.select do
498+ pure $ Rel8.litExpr x Rel8.==. Rel8.litExpr y
472 res === (x == y)
499 res === (x == y)
473
500
474− cover 1 "Equal" $ x == y
475− cover 1 "Not Equal" $ x /= y
476−
477
501
478testTableEquality :: IO TmpPostgres.DB -> TestTree
502testTableEquality :: IO TmpPostgres.DB -> TestTree
479testTableEquality = databasePropertyTest "TestTable equality" \transaction -> do
503testTableEquality = databasePropertyTest "TestTable equality" \transaction -> do
480 (x, y) <- forAll $ liftA2 (,) genTestTable genTestTable
504 (x, y) <- forAll $ liftA2 (,) genTestTable genTestTable
481
505
482− transaction \connection -> do
506+ transaction do
483− [eq] <- liftIO $ Rel8.select connection do
507+ [eq] <- lift do
484− pure $ Rel8.lit x Rel8.==: Rel8.lit y
508+ statement () $ Rel8.select do
509+ pure $ Rel8.lit x Rel8.==: Rel8.lit y
485
510
486 eq === (x == y)
511 eq === (x == y)
487
512
488− cover 1 "Equal" $ x == y
489− cover 1 "Not Equal" $ x /= y
490−
491
513
492testFromString :: IO TmpPostgres.DB -> TestTree
514testFromString :: IO TmpPostgres.DB -> TestTree
493testFromString = databasePropertyTest "FromString" \transaction -> do
515testFromString = databasePropertyTest "FromString" \transaction -> do
494 str <- forAll $ Gen.list (Range.linear 0 10) Gen.unicode
516 str <- forAll $ Gen.list (Range.linear 0 10) Gen.unicode
495
517
496− transaction \connection -> do
518+ transaction do
497− [result] <- liftIO $ Rel8.select connection $ pure $ fromString str
519+ [result] <- lift do
520+ statement () $ Rel8.select do
521+ pure $ fromString str
498 result === pack str
522 result === pack str
499
523
500
524
@@ -502,10 +526,11 @@ testCatMaybeTable :: IO TmpPostgres.DB -> TestTree
502testCatMaybeTable = databasePropertyTest "catMaybeTable" \transaction -> do
526testCatMaybeTable = databasePropertyTest "catMaybeTable" \transaction -> do
503 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
527 rows <- forAll $ Gen.list (Range.linear 0 10) genTestTable
504
528
505− transaction \connection -> do
529+ transaction do
506− selected <- liftIO $ Rel8.select connection do
530+ selected <- lift do
507− testTable <- Rel8.values $ Rel8.lit <$> rows
531+ statement () $ Rel8.select do
508− Rel8.catMaybeTable $ Rel8.bool Rel8.nothingTable (pure testTable) (testTableColumn2 testTable)
532+ testTable <- Rel8.values $ Rel8.lit <$> rows
533+ Rel8.catMaybeTable $ Rel8.bool Rel8.nothingTable (pure testTable) (testTableColumn2 testTable)
509
534
510 sort selected === sort (filter testTableColumn2 rows)
535 sort selected === sort (filter testTableColumn2 rows)
511
536
@@ -514,9 +539,10 @@ testCatMaybe :: IO TmpPostgres.DB -> TestTree
514testCatMaybe = databasePropertyTest "catMaybe" \transaction -> evalM do
539testCatMaybe = databasePropertyTest "catMaybe" \transaction -> evalM do
515 rows <- forAll $ Gen.list (Range.linear 0 10) $ Gen.maybe Gen.bool
540 rows <- forAll $ Gen.list (Range.linear 0 10) $ Gen.maybe Gen.bool
516
541
517− transaction \connection -> do
542+ transaction do
518− selected <- evalM $ liftIO $ Rel8.select connection do
543+ selected <- lift do
519− Rel8.catNull =<< Rel8.values (map Rel8.lit rows)
544+ statement () $ Rel8.select do
545+ Rel8.catNull =<< Rel8.values (map Rel8.lit rows)
520
546
521 sort selected === sort (catMaybes rows)
547 sort selected === sort (catMaybes rows)
522
548
@@ -525,21 +551,44 @@ testMaybeTable :: IO TmpPostgres.DB -> TestTree
525testMaybeTable = databasePropertyTest "maybeTable" \transaction -> evalM do
551testMaybeTable = databasePropertyTest "maybeTable" \transaction -> evalM do
526 (rows, def) <- forAll $ liftA2 (,) (Gen.list (Range.linear 0 10) genTestTable) genTestTable
552 (rows, def) <- forAll $ liftA2 (,) (Gen.list (Range.linear 0 10) genTestTable) genTestTable
527
553
528− transaction \connection -> do
554+ transaction do
529− selected <- liftIO $ Rel8.select connection $
555+ selected <- lift do
530− Rel8.maybeTable (Rel8.lit def) id <$> Rel8.optional (Rel8.values (Rel8.lit <$> rows))
556+ statement () $ Rel8.select do
557+ Rel8.maybeTable (Rel8.lit def) id <$> Rel8.optional (Rel8.values (Rel8.lit <$> rows))
531
558
532 case rows of
559 case rows of
533 [] -> selected === [def]
560 [] -> selected === [def]
534 _ -> sort selected === sort rows
561 _ -> sort selected === sort rows
535
562
536
563
564+testAggregateMaybeTable :: IO TmpPostgres.DB -> TestTree
565+testAggregateMaybeTable = databasePropertyTest "aggregateMaybeTable" \transaction -> evalM do
566+ rows <- forAll $ Gen.list (Range.linear 0 10) (Gen.maybe (Gen.int64 (Range.linear 0 10)))
567+
568+ let
569+ aggregate = go 0 False False
570+ where
571+ go !n nothing _ (Just a : as) = go (n + a) nothing True as
572+ go n _ just (Nothing : as) = go n True just as
573+ go _ False False [] = []
574+ go _ True False [] = [Nothing]
575+ go n False True [] = [Just n]
576+ go n True True [] = [Nothing, Just n]
577+
578+ transaction do
579+ selected <- lift do
580+ statement () $ Rel8.select do
581+ Rel8.aggregate $ Rel8.aggregateMaybeTable Rel8.sum <$> Rel8.values (Rel8.lit <$> rows)
582+
583+ sort selected === aggregate rows
584+
585+
537data TwoTestTables f =
586data TwoTestTables f =
538 TwoTestTables
587 TwoTestTables
539 { testTable1 :: TestTable f
588 { testTable1 :: TestTable f
540 , testTable2 :: TestTable f
589 , testTable2 :: TestTable f
541 }
590 }
542− deriving stock Generic
591+ deriving stock Generic
543 deriving anyclass Rel8.Rel8able
592 deriving anyclass Rel8.Rel8able
544
593
545
594
@@ -554,9 +603,10 @@ testNestedTables = databasePropertyTest "Nested TestTables" \transaction -> eval
554 Gen.list (Range.linear 0 10) $
603 Gen.list (Range.linear 0 10) $
555 liftA2 TwoTestTables genTestTable genTestTable
604 liftA2 TwoTestTables genTestTable genTestTable
556
605
557− transaction \connection -> do
606+ transaction do
558− selected <- liftIO $ Rel8.select connection do
607+ selected <- lift do
559− Rel8.values (Rel8.lit <$> rows)
608+ statement () $ Rel8.select do
609+ Rel8.values (Rel8.lit <$> rows)
560
610
561 sort selected === sort rows
611 sort selected === sort rows
562
612
@@ -566,11 +616,12 @@ testMaybeTableApplicative = databasePropertyTest "MaybeTable (<*>)" \transaction
566 rows1 <- genRows
616 rows1 <- genRows
567 rows2 <- genRows
617 rows2 <- genRows
568
618
569− transaction \connection -> do
619+ transaction do
570− selected <- liftIO $ Rel8.select connection do
620+ selected <- lift do
571− as <- Rel8.optional (Rel8.values (Rel8.lit <$> rows1))
621+ statement () $ Rel8.select do
572− bs <- Rel8.optional (Rel8.values (Rel8.lit <$> rows2))
622+ as <- Rel8.optional (Rel8.values (Rel8.lit <$> rows1))
573− pure $ liftA2 (,) as bs
623+ bs <- Rel8.optional (Rel8.values (Rel8.lit <$> rows2))
624+ pure $ liftA2 (,) as bs
574
625
575 case (rows1, rows2) of
626 case (rows1, rows2) of
576 ([], []) -> selected === [Nothing]
627 ([], []) -> selected === [Nothing]
@@ -582,14 +633,6 @@ testMaybeTableApplicative = databasePropertyTest "MaybeTable (<*>)" \transaction
582 genRows = forAll do
633 genRows = forAll do
583 Gen.list (Range.linear 0 10) $ liftA2 TestTable (Gen.text (Range.linear 0 10) Gen.unicode) (pure True)
634 Gen.list (Range.linear 0 10) $ liftA2 TestTable (Gen.text (Range.linear 0 10) Gen.unicode) (pure True)
584
635
585−rollingBack
586− :: (MonadBaseControl IO m, MonadIO m)
587− => Connection -> m a -> m a
588−rollingBack connection =
589− bracket_
590− (liftIO (run (sql "BEGIN") connection))
591− (liftIO (run (sql "ROLLBACK") connection))
592−
593
636
594genTestTable :: Gen (TestTable Result)
637genTestTable :: Gen (TestTable Result)
595genTestTable = do
638genTestTable = do
@@ -602,19 +645,19 @@ testUpdate :: IO TmpPostgres.DB -> TestTree
602testUpdate = databasePropertyTest "Can UPDATE TestTable" \transaction -> do
645testUpdate = databasePropertyTest "Can UPDATE TestTable" \transaction -> do
603 rows <- forAll $ Gen.map (Range.linear 0 5) $ liftA2 (,) genTestTable genTestTable
646 rows <- forAll $ Gen.map (Range.linear 0 5) $ liftA2 (,) genTestTable genTestTable
604
647
605− transaction \connection -> do
648+ transaction do
606− void $ liftIO $ Rel8.insert connection
649+ selected <- lift do
607− Rel8.Insert
650+ statement () $ Rel8.insert Rel8.Insert
608 { into = testTableSchema
651 { into = testTableSchema
609− , rows = map (Rel8.toInsert . Rel8.lit) $ Map.keys rows
652+ , rows = Rel8.values $ map Rel8.lit $ Map.keys rows
610 , onConflict = Rel8.DoNothing
653 , onConflict = Rel8.DoNothing
611− , returning = Rel8.NumberOfRowsAffected
654+ , returning = pure ()
612 }
655 }
613
656
614− void $ liftIO $ Rel8.update connection
657+ statement () $ Rel8.update Rel8.Update
615− Rel8.Update
616 { target = testTableSchema
658 { target = testTableSchema
617− , set = \r ->
659+ , from = pure ()
660+ , set = \_ r ->
618 let updates = map (bimap Rel8.lit Rel8.lit) $ Map.toList rows
661 let updates = map (bimap Rel8.lit Rel8.lit) $ Map.toList rows
619 in
662 in
620 foldl
663 foldl
@@ -628,12 +671,12 @@ testUpdate = databasePropertyTest "Can UPDATE TestTable" \transaction -> do
628 )
671 )
629 r
672 r
630 updates
673 updates
631− , updateWhere = \_ -> Rel8.lit True
674+ , updateWhere = \_ _ -> Rel8.lit True
632− , returning = Rel8.NumberOfRowsAffected
675+ , returning = pure ()
633 }
676 }
634
677
635− selected <- liftIO $ Rel8.select connection do
678+ statement () $ Rel8.select do
636− Rel8.each testTableSchema
679+ Rel8.each testTableSchema
637
680
638 sort selected === sort (Map.elems rows)
681 sort selected === sort (Map.elems rows)
639
682
@@ -646,29 +689,96 @@ testDelete :: IO TmpPostgres.DB -> TestTree
646testDelete = databasePropertyTest "Can DELETE TestTable" \transaction -> do
689testDelete = databasePropertyTest "Can DELETE TestTable" \transaction -> do
647 rows <- forAll $ Gen.list (Range.linear 0 5) genTestTable
690 rows <- forAll $ Gen.list (Range.linear 0 5) genTestTable
648
691
649− transaction \connection -> do
692+ transaction do
650− void $ liftIO $ Rel8.insert connection
693+ (deleted, selected) <- lift do
651− Rel8.Insert
694+ statement () $ Rel8.insert Rel8.Insert
652 { into = testTableSchema
695 { into = testTableSchema
653− , rows = map (Rel8.toInsert . Rel8.lit) rows
696+ , rows = Rel8.values $ map Rel8.lit rows
654 , onConflict = Rel8.DoNothing
697 , onConflict = Rel8.DoNothing
655− , returning = Rel8.NumberOfRowsAffected
698+ , returning = pure ()
656 }
699 }
657
700
658− deleted <-
701+ deleted <- statement () $ Rel8.delete Rel8.Delete
659− liftIO $ Rel8.delete connection
660− Rel8.Delete
661 { from = testTableSchema
702 { from = testTableSchema
662− , deleteWhere = testTableColumn2
703+ , using = pure ()
704+ , deleteWhere = const testTableColumn2
663 , returning = Rel8.Projection id
705 , returning = Rel8.Projection id
664 }
706 }
665
707
666− selected <- liftIO $ Rel8.select connection do
708+ selected <- statement () $ Rel8.select do
667− Rel8.each testTableSchema
709+ Rel8.each testTableSchema
710+
711+ pure (deleted, selected)
668
712
669 sort (deleted <> selected) === sort rows
713 sort (deleted <> selected) === sort rows
670
714
671
715
716+data UniqueTable f = UniqueTable
717+ { uniqueTableKey :: Rel8.Column f Text
718+ , uniqueTableValue :: Rel8.Column f Text
719+ }
720+ deriving stock Generic
721+ deriving anyclass Rel8.Rel8able
722+
723+
724+deriving stock instance Eq (UniqueTable Result)
725+deriving stock instance Ord (UniqueTable Result)
726+deriving stock instance Show (UniqueTable Result)
727+
728+
729+uniqueTableSchema :: Rel8.TableSchema (UniqueTable Rel8.Name)
730+uniqueTableSchema =
731+ Rel8.TableSchema
732+ { name = "unique_table"
733+ , schema = Nothing
734+ , columns = UniqueTable
735+ { uniqueTableKey = "key"
736+ , uniqueTableValue = "value"
737+ }
738+ }
739+
740+
741+genUniqueTable :: Gen (UniqueTable Result)
742+genUniqueTable = do
743+ uniqueTableKey <- Gen.text (Range.linear 0 5) Gen.alphaNum
744+ uniqueTableValue <- Gen.text (Range.linear 0 5) Gen.alphaNum
745+ pure UniqueTable {..}
746+
747+
748+testUpsert :: IO TmpPostgres.DB -> TestTree
749+testUpsert = databasePropertyTest "Can UPSERT UniqueTable" \transaction -> do
750+ as <- unique $ forAll $ Gen.list (Range.linear 0 20) genUniqueTable
751+ bs <- unique $ forAll $ Gen.list (Range.linear 0 20) genUniqueTable
752+
753+ transaction do
754+ selected <- lift do
755+ statement () $ Rel8.insert Rel8.Insert
756+ { into = uniqueTableSchema
757+ , rows = Rel8.values $ Rel8.lit <$> as
758+ , onConflict = Rel8.DoNothing
759+ , returning = pure ()
760+ }
761+
762+ statement () $ Rel8.insert Rel8.Insert
763+ { into = uniqueTableSchema
764+ , rows = Rel8.values $ Rel8.lit <$> bs
765+ , onConflict = Rel8.DoUpdate Rel8.Upsert
766+ { index = uniqueTableKey
767+ , set = \UniqueTable {uniqueTableValue} old -> old {uniqueTableValue}
768+ , updateWhere = \_ _ -> Rel8.true
769+ }
770+ , returning = pure ()
771+ }
772+
773+ statement () $ Rel8.select do
774+ Rel8.each uniqueTableSchema
775+
776+ fromUniqueTables selected === fromUniqueTables bs <> fromUniqueTables as
777+ where
778+ unique = fmap (nubOrdOn uniqueTableKey)
779+ fromUniqueTables = Map.fromList . map \(UniqueTable key value) -> (key, value)
780+
781+
672newtype HKNestedPair f = HKNestedPair { pairOne :: (TestTable f, TestTable f) }
782newtype HKNestedPair f = HKNestedPair { pairOne :: (TestTable f, TestTable f) }
673 deriving stock Generic
783 deriving stock Generic
674 deriving anyclass Rel8.Rel8able
784 deriving anyclass Rel8.Rel8able
@@ -682,9 +792,10 @@ testSelectNestedPairs :: IO TmpPostgres.DB -> TestTree
682testSelectNestedPairs = databasePropertyTest "Can SELECT nested pairs" \transaction -> do
792testSelectNestedPairs = databasePropertyTest "Can SELECT nested pairs" \transaction -> do
683 rows <- forAll $ Gen.list (Range.linear 0 10) $ HKNestedPair <$> liftA2 (,) genTestTable genTestTable
793 rows <- forAll $ Gen.list (Range.linear 0 10) $ HKNestedPair <$> liftA2 (,) genTestTable genTestTable
684
794
685− transaction \connection -> do
795+ transaction do
686− selected <- liftIO $ Rel8.select connection do
796+ selected <- lift do
687− Rel8.values $ map Rel8.lit rows
797+ statement () $ Rel8.select do
798+ Rel8.values $ map Rel8.lit rows
688
799
689 sort selected === sort rows
800 sort selected === sort rows
690
801
@@ -693,12 +804,23 @@ testSelectArray :: IO TmpPostgres.DB -> TestTree
693testSelectArray = databasePropertyTest "Can SELECT Arrays (with aggregation)" \transaction -> do
804testSelectArray = databasePropertyTest "Can SELECT Arrays (with aggregation)" \transaction -> do
694 rows <- forAll $ Gen.list (Range.linear 1 10) Gen.bool
805 rows <- forAll $ Gen.list (Range.linear 1 10) Gen.bool
695
806
696− transaction \connection -> do
807+ transaction do
697− selected <- liftIO $ Rel8.select connection $ Rel8.aggregate do
808+ selected <- lift do
698− Rel8.listAgg <$> Rel8.values (map Rel8.lit rows)
809+ statement () $ Rel8.select do
810+ Rel8.many $ Rel8.values (map Rel8.lit rows)
699
811
700 selected === [foldMap pure rows]
812 selected === [foldMap pure rows]
701
813
814+ selected' <- lift do
815+ statement () $ Rel8.select do
816+ a <- Rel8.catListTable =<< do
817+ Rel8.many $ Rel8.values (map Rel8.lit rows)
818+ b <- Rel8.catListTable =<< do
819+ Rel8.many $ Rel8.values (map Rel8.lit rows)
820+ pure (a, b)
821+
822+ selected' === liftA2 (,) rows rows
823+
702
824
703data NestedMaybeTable f = NestedMaybeTable
825data NestedMaybeTable f = NestedMaybeTable
704 { nmt1 :: Rel8.Column f Bool
826 { nmt1 :: Rel8.Column f Bool
@@ -717,9 +839,51 @@ testNestedMaybeTable :: IO TmpPostgres.DB -> TestTree
717testNestedMaybeTable = databasePropertyTest "Can nest MaybeTable within other tables" \transaction -> do
839testNestedMaybeTable = databasePropertyTest "Can nest MaybeTable within other tables" \transaction -> do
718 let example = NestedMaybeTable { nmt1 = True, nmt2 = Just (TestTable "Hi" True) }
840 let example = NestedMaybeTable { nmt1 = True, nmt2 = Just (TestTable "Hi" True) }
719
841
720− transaction \connection -> do
842+ transaction do
721− selected <- liftIO $ Rel8.select connection do
843+ selected <- lift do
722− x <- Rel8.values [Rel8.lit example]
844+ statement () $ Rel8.select do
723− pure $ Rel8.maybeTable (Rel8.lit False) (\_ -> Rel8.lit True) (nmt2 x)
845+ x <- Rel8.values [Rel8.lit example]
846+ pure $ Rel8.maybeTable (Rel8.lit False) (\_ -> Rel8.lit True) (nmt2 x)
724
847
725 selected === [True]
848 selected === [True]
849+
850+
851+testEvaluate :: IO TmpPostgres.DB -> TestTree
852+testEvaluate = databasePropertyTest "evaluate has the evaluation order we expect" \transaction -> do
853+
854+ transaction do
855+ selected <- lift do
856+ statement () $ Rel8.select do
857+ x <- Rel8.values (Rel8.lit <$> ['a', 'b', 'c'])
858+ y <- Rel8.evaluate (Rel8.nextval "test_seq")
859+ pure (x, (y, y))
860+
861+ normalize selected ===
862+ [ ('a', (0, 0))
863+ , ('b', (1, 1))
864+ , ('c', (2, 2))
865+ ]
866+
867+ selected' <- lift do
868+ statement () $ Rel8.select do
869+ x <- Rel8.values (Rel8.lit <$> ['a', 'b', 'c'])
870+ y <- Rel8.values (Rel8.lit <$> ['d', 'e', 'f'])
871+ z <- Rel8.evaluate (Rel8.nextval "test_seq")
872+ pure ((x, y), (z, z))
873+
874+ normalize selected' ===
875+ [ (('a', 'd'), (0, 0))
876+ , (('a', 'e'), (1, 1))
877+ , (('a', 'f'), (2, 2))
878+ , (('b', 'd'), (3, 3))
879+ , (('b', 'e'), (4, 4))
880+ , (('b', 'f'), (5, 5))
881+ , (('c', 'd'), (6, 6))
882+ , (('c', 'e'), (7, 7))
883+ , (('c', 'f'), (8, 8))
884+ ]
885+
886+ where
887+ normalize :: [(x, (Int64, Int64))] -> [(x, (Int64, Int64))]
888+ normalize [] = []
889+ normalize xs@((_, (i, _)) : _) = map (fmap (\(a, b) -> (a - i, b - i))) xs
src/Rel8/Schema/Generic/Test.hs → tests/Rel8/Generic/Rel8able/Test.hsrenamed+83−13
@@ -1,17 +1,18 @@
1{-# language DataKinds #-}
1{-# language DataKinds #-}
2{-# language DeriveAnyClass #-}
2{-# language DeriveAnyClass #-}
3{-# language DeriveGeneric #-}
3{-# language DeriveGeneric #-}
4−{-# language DerivingVia #-}
4+{-# language DerivingStrategies #-}
5{-# language DuplicateRecordFields #-}
5{-# language DuplicateRecordFields #-}
6{-# language FlexibleInstances #-}
6{-# language FlexibleInstances #-}
7{-# language MultiParamTypeClasses #-}
7{-# language MultiParamTypeClasses #-}
8−{-# language StandaloneDeriving #-}
8+{-# language StandaloneKindSignatures #-}
9{-# language TypeFamilies #-}
9{-# language TypeFamilies #-}
10+{-# language UndecidableInstances #-}
10
11
11{-# options_ghc -O0 #-}
12{-# options_ghc -O0 #-}
12
13
13−module Rel8.Schema.Generic.Test
14+module Rel8.Generic.Rel8able.Test
14− ( module Rel8.Schema.Generic.Test
15+ ( module Rel8.Generic.Rel8able.Test
15 )
16 )
16where
17where
17
18
@@ -19,9 +20,6 @@ where
19import GHC.Generics ( Generic )
20import GHC.Generics ( Generic )
20import Prelude
21import Prelude
21
22
22−-- higgledy
23−import Data.Generic.HKD ( HKD )
24−
25-- rel8
23-- rel8
26import Rel8
24import Rel8
27
25
@@ -29,7 +27,7 @@ import Rel8
29import Data.Text ( Text )
27import Data.Text ( Text )
30
28
31
29
32−data Table f = Table
30+data TableTest f = TableTest
33 { foo :: Column f Bool
31 { foo :: Column f Bool
34 , bar :: Column f (Maybe Bool)
32 , bar :: Column f (Maybe Bool)
35 }
33 }
@@ -38,7 +36,7 @@ data Table f = Table
38
36
39
37
40data TablePair f = TablePair
38data TablePair f = TablePair
41− { foo :: Default f Bool
39+ { foo :: Column f Bool
42 , bars :: (Column f Text, Column f Text)
40 , bars :: (Column f Text, Column f Text)
43 }
41 }
44 deriving stock Generic
42 deriving stock Generic
@@ -85,6 +83,14 @@ data TableNonEmpty f = TableNonEmpty
85 deriving anyclass Rel8able
83 deriving anyclass Rel8able
86
84
87
85
86+data TableNest f = TableNest
87+ { foo :: Column f Bool
88+ , bars :: HList f (HMaybe f (TablePair f))
89+ }
90+ deriving stock Generic
91+ deriving anyclass Rel8able
92+
93+
88data S3Object = S3Object
94data S3Object = S3Object
89 { bucketName :: Text
95 { bucketName :: Text
90 , objectKey :: Text
96 , objectKey :: Text
@@ -92,13 +98,20 @@ data S3Object = S3Object
92 deriving stock Generic
98 deriving stock Generic
93
99
94
100
95−deriving via HKDT S3Object
101+instance x ~ HKD S3Object Expr => ToExprs x S3Object
96− instance x ~ HKD S3Object Expr => ToExprs x S3Object
102+
103+
104+data HKDSum = HKDSumA Text | HKDSumB Bool Char | HKDSumC
105+ deriving stock Generic
106+
97
107
108+instance x ~ HKD HKDSum Expr => ToExprs x HKDSum
98
109
99−newtype HKDTest f = HKDTest
110+
111+data HKDTest f = HKDTest
100 { s3Object :: Lift f S3Object
112 { s3Object :: Lift f S3Object
101− }
113+ , hkdSum :: Lift f HKDSum
114+ }
102 deriving stock Generic
115 deriving stock Generic
103 deriving anyclass Rel8able
116 deriving anyclass Rel8able
104
117
@@ -116,3 +129,60 @@ data NonRecord f = NonRecord
116 (Column f Char)
129 (Column f Char)
117 deriving stock Generic
130 deriving stock Generic
118 deriving anyclass Rel8able
131 deriving anyclass Rel8able
132+
133+
134+data TableSum f
135+ = TableSumA (Column f Bool) (Column f Text)
136+ | TableSumB
137+ | TableSumC (Column f Text)
138+ deriving stock Generic
139+
140+
141+data BarbieSum f
142+ = BarbieSumA (f Bool) (f Text)
143+ | BarbieSumB
144+ | BarbieSumC (f Text)
145+ deriving stock Generic
146+
147+
148+data TableProduct f = TableProduct
149+ { sum :: HADT f BarbieSum
150+ , list :: TableList f
151+ , foos :: HList f (HADT f TableSum, Lift f HKDSum, HKDTest f)
152+ }
153+ deriving stock Generic
154+ deriving anyclass Rel8able
155+
156+
157+data TableTestB f = TableTestB
158+ { foo :: f Bool
159+ , bar :: f (Maybe Bool)
160+ }
161+ deriving stock Generic
162+ deriving anyclass Rel8able
163+
164+
165+data NestedTableTestB f = NestedTableTestB
166+ { foo :: f Bool
167+ , bar :: f (Maybe Bool)
168+ , baz :: Column f Char
169+ , nest :: TableTestB f
170+ }
171+ deriving stock Generic
172+ deriving anyclass Rel8able
173+
174+
175+newtype IdRecord a f = IdRecord { recordId :: Column f a }
176+ deriving stock Generic
177+
178+
179+instance DBType a => Rel8able (IdRecord a)
180+
181+
182+type Nest :: KRel8able -> KRel8able -> KRel8able
183+data Nest t u f = Nest
184+ { foo :: t f
185+ , bar :: u f
186+ }
187+ deriving stock Generic
188+ deriving anyclass Rel8able