feat: PR prep cleanup; changelog

Author: ulidtko

changelog.md

@@ -1,3 +1,9 @@
+3.5.10.2 (unreleased)
+=======
+- @ulidtko
+    - PR TBD
+      - Add `updateReturning`, `deleteReturning` as Postgres extensions.
+
 3.5.10.1
 ========
 - @9999years
@@ -21,7 +27,6 @@
     - [#363](https://github.com/bitemyapp/esqueleto/pull/363)
       - Add missing `just` to left join examples in the Haddocks
 
-
 3.5.9.0
 =======
 - @9999years

src/Database/Esqueleto/Internal/Internal.hs

@@ -1882,9 +1882,7 @@ data CommonTableExpressionClause =
 
 data ReturningClause
     = ReturningNothing  -- ^ The default, absent clause.
-    | ReturningStar     -- ^ @RETURNING *@
-    -- | ReturningExprs (NonEmpty (SqlExpr Returning))
-    -- ^ @output_expression [ [ AS ] output_name ] [, ...]@
+    | ReturningStar     -- ^ @RETURNING@ is present.
 
 data SubQueryType
     = NormalSubQuery
@@ -2128,7 +2126,6 @@ instance Semigroup ReturningClause where
   (<>) ReturningNothing x = x
   (<>) x ReturningNothing = x
   (<>) ReturningStar ReturningStar = ReturningStar
---   (<>) _ _ = error "instance Semigroup FIXME"
 
 instance Monoid ReturningClause where
   mempty = ReturningNothing
@@ -2421,6 +2418,9 @@ existsHelper = sub SELECT . (>> return true)
 --
 -- Many constructs appearing in @SELECT@ can go under @RETURNING@ -- but not all (e.g.
 -- certainly not subqueries, @VALUES@ and such). Thus, this is a subclass of 'SqlSelect'.
+--
+-- The fundeps duplicate those of 'SqlSelect' solely to provide somewhat more directly
+-- understandable type errors.
 class SqlSelect a r => InferReturning a r | r -> a, a -> r
 instance PersistEntity ent => InferReturning (SqlExpr (Entity ent)) (Entity ent)
 instance PersistEntity ent => InferReturning (SqlExpr (Maybe (Entity ent))) (Maybe (Entity ent))
@@ -3314,7 +3314,6 @@ makeReturning :: SqlSelect a r
               => IdentInfo -> ReturningClause -> a -> (TLB.Builder, [PersistValue])
 makeReturning _    ReturningNothing _ = mempty
 makeReturning info ReturningStar  ret = ("RETURNING ", []) <> sqlSelectCols info ret
--- makeReturning info (ReturningExprs _) = undefined -- FIXME
 
 
 parens :: TLB.Builder -> TLB.Builder

test/PostgreSQL/Test.hs

@@ -1058,7 +1058,7 @@ testUpsert =
 
 testUpdateDeleteReturning :: SpecDb
 testUpdateDeleteReturning =
-  describe "UPDATE .. RETURNING *" $ do
+  describe "UPDATE .. RETURNING .." $ do
     itDb "Whole entities, expressions and tuples get returned from UPDATE" $ do
       [_p1k, _p2k, _p3k, p4k, _p5k] <- mapM insert [p1, p2, p3, p4, p5]
       ret1 <- EP.updateReturning $ \p -> do