Support UPDATE/DELETE .. RETURNING #362
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,8 @@ | |
| , chr | ||
| , now_ | ||
| , random_ | ||
| , deleteReturning | ||
| , updateReturning | ||
| , upsert | ||
| , upsertBy | ||
| , insertSelectWithConflict | ||
|
|
@@ -41,6 +43,7 @@ | |
| #if __GLASGOW_HASKELL__ < 804 | ||
| import Data.Semigroup | ||
| #endif | ||
| import Conduit (withAcquire) | ||
| import Control.Arrow (first) | ||
| import Control.Exception (throw) | ||
| import Control.Monad (void) | ||
|
|
@@ -75,7 +78,7 @@ | |
| (PersistField a, PersistField [a]) | ||
| => SqlExpr (Value (Maybe [a])) | ||
| -> SqlExpr (Value [a]) | ||
| maybeArray x = coalesceDefault [x] emptyArray | ||
|
|
||
| -- | Aggregate mode | ||
| data AggMode | ||
|
|
@@ -238,7 +241,7 @@ | |
| queryVals = | ||
| addVals updateVals | ||
| xs <- rawSql queryText queryVals | ||
| pure (head xs) | ||
|
Check warning on line 244 in src/Database/Esqueleto/PostgreSQL.hs
|
||
| #else | ||
| uDef = toUniqueDef uniqueKey | ||
| handler conn f = fmap head $ uncurry rawSql $ | ||
|
|
@@ -280,7 +283,7 @@ | |
| -- @since 3.1.3 | ||
| insertSelectWithConflict | ||
| :: forall a m val backend | ||
| . (FinalResult a, KnowResult a ~ Unique val, MonadIO m, PersistEntity val, SqlBackendCanWrite backend) | ||
|
Check warning on line 286 in src/Database/Esqueleto/PostgreSQL.hs
|
||
| => a | ||
| -- ^ Unique constructor or a unique, this is used just to get the name of | ||
| -- the postgres constraint, the value(s) is(are) never used, so if you have | ||
|
|
@@ -300,7 +303,7 @@ | |
| -- @since 3.1.3 | ||
| insertSelectWithConflictCount | ||
| :: forall a val m backend | ||
| . (FinalResult a, KnowResult a ~ Unique val, MonadIO m, PersistEntity val, | ||
|
Check warning on line 306 in src/Database/Esqueleto/PostgreSQL.hs
|
||
| SqlBackendCanWrite backend) | ||
| => a | ||
| -> SqlQuery (SqlExpr (Insertion val)) | ||
|
|
@@ -477,3 +480,49 @@ | |
| forShareOf :: LockableEntity a => a -> OnLockedBehavior -> SqlQuery () | ||
| forShareOf lockableEntities onLockedBehavior = | ||
| putLocking $ PostgresLockingClauses [PostgresLockingKind PostgresForShare (Just $ LockingOfClause lockableEntities) onLockedBehavior] | ||
|
|
||
| -- | `UPDATE .. RETURNING ..` SQL extension supported by Postgres. | ||
| -- | ||
| -- The instances of 'InferReturning' say what can be returned; currently includes | ||
| -- whole entities, 'PersistField's, SQL expressions, tuples (possibly nested). | ||
| -- | ||
| -- Usage example: | ||
| -- | ||
| -- @ | ||
| -- tuples <- updateReturning $ \p -> do | ||
| -- set p [ PersonAge =. val (Just 0) ] | ||
| -- where_ (isNothing $ p ^. PersonAge) | ||
| -- return (val True, p ^. PersonName, (p ^. PersonFavNum) *. val 100) | ||
| -- -- return p -- also works, returning (Entity Person) | ||
| -- @ | ||
| -- | ||
| -- @since 3.5.11.3 | ||
| updateReturning :: (MonadIO m, From from, InferReturning ex ret, SqlBackendCanWrite backend) | ||
| => (from -> SqlQuery ex) | ||
| -> R.ReaderT backend m [ret] | ||
| updateReturning block = do | ||
| conn <- R.ask | ||
| conduit <- rawSelectSource UPDATE (tellReturning ReturningStar >> from block) | ||
| liftIO . withAcquire conduit $ flip R.runReaderT conn . runSource | ||
|
There was a problem hiding this comment. So this is the use of the new functionality - neat. This is where we say "Do the rawSelectSource UPDATE (tellReturning ReturningStar >> from block)So we modify the I think we can avoid modifying Consider If the If we look at the code for So, if we inline this and use updateReturning block = do
conn <- R.ask
let
query' = toRawSql UPDATE (conn, initialIdentState) block
((ret, _sd), _finalIdent) = flip S.runState -- ... (from toRawSql)
returningClause = ("RETURNING ", []) <> sqlSelectCols info ret
(queryWithReturning, vals) =
query' <> ("\n", []) <> returningClause
rawQuery queryWithReturning valsNow, it is unsatisfying that we have to run the query building twice with this - once in If conn <- R.ask
let
(ret, query') = toRawSqlWith UPDATE (conn, initialIdentState) block
returningClause = ("\nRETURNING ", []) <> sqlSelectCols info ret
(queryWithReturning, vals) =
query' <> returningClause
rawQuery queryWithReturning valsThen I think there's probably virtue in writing |
||
|
|
||
| -- | `DELETE .. RETURNING` SQL extension supported by Postgres. | ||
| -- | ||
| -- The instances of 'InferReturning' say what can be returned; currently includes | ||
| -- whole entities, 'PersistField's, SQL expressions, tuples (possibly nested). | ||
| -- | ||
| -- Usage example: | ||
| -- | ||
| -- @ | ||
| -- removedRowsWithNames <- deleteReturning $ \p -> do | ||
| -- where_ (isNothing $ p ^. PersonWeight) | ||
| -- return (p, p ^. PersonName) | ||
| -- @ | ||
| -- | ||
| -- @since 3.5.11.3 | ||
| deleteReturning :: (MonadIO m, From from, InferReturning ex ret, SqlBackendCanWrite backend) | ||
| => (from -> SqlQuery ex) | ||
| -> R.ReaderT backend m [ret] | ||
| deleteReturning block = do | ||
| conn <- R.ask | ||
| conduit <- rawSelectSource DELETE (tellReturning ReturningStar >> from block) | ||
| liftIO . withAcquire conduit $ flip R.runReaderT conn . runSource | ||
ulidtko marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1056,6 +1056,38 @@ testUpsert = | |
| u3e <- EP.upsert u3 [OneUniqueName =. val "fifth"] | ||
| liftIO $ entityVal u3e `shouldBe` u1{oneUniqueName="fifth"} | ||
|
|
||
| testUpdateDeleteReturning :: SpecDb | ||
| testUpdateDeleteReturning = | ||
| 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 | ||
| set p [ PersonFavNum =. val 42 ] | ||
| where_ (p ^. PersonFavNum ==. val 4) | ||
| return p | ||
| asserting $ ret1 `shouldBe` [Entity p4k p4{ personFavNum = 42 }] | ||
ulidtko marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ret2 <- EP.updateReturning $ \p -> do | ||
| set p [ PersonAge =. val (Just 0) ] | ||
| where_ (isNothing $ p ^. PersonAge) | ||
| return (val True, p ^. PersonName, (p ^. PersonFavNum) *. val 100) | ||
| asserting $ ret2 `shouldBe` [ (Value True, Value "Rachel", Value 200) | ||
| , (Value True, Value "Mitch", Value 500) ] | ||
|
|
||
| itDb "Whole entities, expressions and tuples get returned from DELETE" $ do | ||
| [_p1k, p2k, _p3k, p4k, _p5k] <- mapM insert [p1, p2, p3, p4, p5] | ||
| ret1 <- EP.deleteReturning $ \p -> do | ||
| where_ (isNothing $ p ^. PersonWeight) | ||
| return (val (1 :: Int, 2 :: Int), p ^. PersonName, isNothing (p ^. PersonAge)) | ||
| asserting $ ret1 `shouldBe` [ (Value (1, 2), Value "John", Value False) | ||
| , (Value (1, 2), Value "Mike", Value False) | ||
| , (Value (1, 2), Value "Mitch", Value True) ] | ||
| ret2 <- EP.deleteReturning $ \p -> do | ||
| -- empty WHERE -- delete everything remaining... but: | ||
| return (p, p ^. PersonName) | ||
| asserting $ ret2 `shouldBe` [ (Entity p2k p2, Value "Rachel") | ||
| , (Entity p4k p4, Value "Livia") ] | ||
ulidtko marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| testInsertSelectWithConflict :: SpecDb | ||
| testInsertSelectWithConflict = | ||
| describe "insertSelectWithConflict test" $ do | ||
|
|
@@ -1629,6 +1661,7 @@ spec = beforeAll mkConnectionPool $ do | |
| testPostgresqlTextFunctions | ||
| testInsertUniqueViolation | ||
| testUpsert | ||
| testUpdateDeleteReturning | ||
| testInsertSelectWithConflict | ||
| testFilterWhere | ||
| testCommonTableExpressions | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This implementation adds a field to the
SideDatatype, which unfortunately does make this a breaking change and would need to go out as3.6.0.0.However, I've suggested an alternative implementation that should be strictly additive, allowing it to be
3.5.12.0.