Database.Beam.Backend.SQL.BeamExtensions

Some functionality is useful enough to be provided across backends, but is not standardized. For example, many RDBMS systems provide ways of fetching auto-incrementing or defaulting fields on INSERT or UPDATE.

Beam provides type classes that some backends instantiate that provide this support. This uses direct means on sufficiently advanced backends and is emulated on others.

Documentation

class MonadBeam syntax be handle m => MonadBeamInsertReturning syntax be handle m | m -> syntax be handle, be -> m, handle -> m where

MonadBeams that support returning the newly created rows of an INSERT statement. Useful for discovering the real value of a defaulted value.

Minimal complete definition

runInsertReturningList

Methods

runInsertReturningList :: (Beamable table, Projectible (Sql92ExpressionSyntax syntax) (table (QExpr (Sql92ExpressionSyntax syntax) ())), FromBackendRow be (table Identity)) => DatabaseEntity be db (TableEntity table) -> SqlInsertValues (Sql92InsertValuesSyntax (Sql92InsertSyntax syntax)) (table (QExpr (Sql92InsertExpressionSyntax (Sql92InsertSyntax syntax)) s)) -> m [table Identity]

class MonadBeam syntax be handle m => MonadBeamUpdateReturning syntax be handle m | m -> syntax be handle, be -> m, handle -> m where

MonadBeams that support returning the updated rows of an UPDATE statement. Useful for discovering the new values of the updated rows.

Minimal complete definition

runUpdateReturningList

Methods

runUpdateReturningList :: (Beamable table, Projectible (Sql92ExpressionSyntax syntax) (table (QExpr (Sql92ExpressionSyntax syntax) ())), FromBackendRow be (table Identity)) => DatabaseEntity be db (TableEntity table) -> (forall s. table (QField s) -> [QAssignment (Sql92UpdateFieldNameSyntax (Sql92UpdateSyntax syntax)) (Sql92UpdateExpressionSyntax (Sql92UpdateSyntax syntax)) s]) -> (forall s. table (QExpr (Sql92UpdateExpressionSyntax (Sql92UpdateSyntax syntax)) s) -> QExpr (Sql92UpdateExpressionSyntax (Sql92UpdateSyntax syntax)) s Bool) -> m [table Identity]

class MonadBeam syntax be handle m => MonadBeamDeleteReturning syntax be handle m | m -> syntax be handle, be -> m, handle -> m where

MonadBeams that suppert returning rows that will be deleted by the given DELETE statement. Useful for deallocating resources based on the value of deleted rows.

Minimal complete definition

runDeleteReturningList

Methods

runDeleteReturningList :: (Beamable table, Projectible (Sql92ExpressionSyntax syntax) (table (QExpr (Sql92ExpressionSyntax syntax) ())), FromBackendRow be (table Identity)) => DatabaseEntity be db (TableEntity table) -> (forall s. table (QExpr (Sql92UpdateExpressionSyntax (Sql92UpdateSyntax syntax)) s) -> QExpr (Sql92UpdateExpressionSyntax (Sql92UpdateSyntax syntax)) s Bool) -> m [table Identity]

newtype SqlSerial a

Constructors

SqlSerial

Fields

• unSerial :: a

Instances

FromBackendRow be x => FromBackendRow be (SqlSerial x)

Methods

fromBackendRow :: FromBackendRowM be (SqlSerial x)

valuesNeeded :: Proxy * be -> Proxy * (SqlSerial x) -> Int

HasSqlValueSyntax syntax x => HasSqlValueSyntax syntax (SqlSerial x)

Methods

sqlValueSyntax :: SqlSerial x -> syntax

HasSqlQuantifiedEqualityCheck syntax a => HasSqlQuantifiedEqualityCheck syntax (SqlSerial a)

Methods

sqlQEqE :: Proxy * (SqlSerial a) -> Maybe (Sql92ExpressionQuantifierSyntax syntax) -> syntax -> syntax -> syntax

sqlQNeqE :: Proxy * (SqlSerial a) -> Maybe (Sql92ExpressionQuantifierSyntax syntax) -> syntax -> syntax -> syntax

HasSqlEqualityCheck syntax a => HasSqlEqualityCheck syntax (SqlSerial a)

Methods

sqlEqE :: Proxy * (SqlSerial a) -> syntax -> syntax -> syntax

sqlNeqE :: Proxy * (SqlSerial a) -> syntax -> syntax -> syntax

sqlEqTriE :: Proxy * (SqlSerial a) -> syntax -> syntax -> syntax

sqlNeqTriE :: Proxy * (SqlSerial a) -> syntax -> syntax -> syntax

Enum a => Enum (SqlSerial a)

Methods

succ :: SqlSerial a -> SqlSerial a

pred :: SqlSerial a -> SqlSerial a

toEnum :: Int -> SqlSerial a

fromEnum :: SqlSerial a -> Int

enumFrom :: SqlSerial a -> [SqlSerial a]

enumFromThen :: SqlSerial a -> SqlSerial a -> [SqlSerial a]

enumFromTo :: SqlSerial a -> SqlSerial a -> [SqlSerial a]

enumFromThenTo :: SqlSerial a -> SqlSerial a -> SqlSerial a -> [SqlSerial a]

Eq a => Eq (SqlSerial a)

Methods

(==) :: SqlSerial a -> SqlSerial a -> Bool

(/=) :: SqlSerial a -> SqlSerial a -> Bool

Integral a => Integral (SqlSerial a)

Methods

quot :: SqlSerial a -> SqlSerial a -> SqlSerial a

rem :: SqlSerial a -> SqlSerial a -> SqlSerial a

div :: SqlSerial a -> SqlSerial a -> SqlSerial a

mod :: SqlSerial a -> SqlSerial a -> SqlSerial a

quotRem :: SqlSerial a -> SqlSerial a -> (SqlSerial a, SqlSerial a)

divMod :: SqlSerial a -> SqlSerial a -> (SqlSerial a, SqlSerial a)

toInteger :: SqlSerial a -> Integer

Num a => Num (SqlSerial a)

Methods

(+) :: SqlSerial a -> SqlSerial a -> SqlSerial a

(-) :: SqlSerial a -> SqlSerial a -> SqlSerial a

(*) :: SqlSerial a -> SqlSerial a -> SqlSerial a

negate :: SqlSerial a -> SqlSerial a

abs :: SqlSerial a -> SqlSerial a

signum :: SqlSerial a -> SqlSerial a

fromInteger :: Integer -> SqlSerial a

Ord a => Ord (SqlSerial a)

Methods

compare :: SqlSerial a -> SqlSerial a -> Ordering

(<) :: SqlSerial a -> SqlSerial a -> Bool

(<=) :: SqlSerial a -> SqlSerial a -> Bool

(>) :: SqlSerial a -> SqlSerial a -> Bool

(>=) :: SqlSerial a -> SqlSerial a -> Bool

max :: SqlSerial a -> SqlSerial a -> SqlSerial a

min :: SqlSerial a -> SqlSerial a -> SqlSerial a

Read a => Read (SqlSerial a)

Methods

readsPrec :: Int -> ReadS (SqlSerial a)

readList :: ReadS [SqlSerial a]

readPrec :: ReadPrec (SqlSerial a)

readListPrec :: ReadPrec [SqlSerial a]

Real a => Real (SqlSerial a)

Methods

toRational :: SqlSerial a -> Rational

Show a => Show (SqlSerial a)

Methods

showsPrec :: Int -> SqlSerial a -> ShowS

show :: SqlSerial a -> String

showList :: [SqlSerial a] -> ShowS

ToJSON a => ToJSON (SqlSerial a)

Methods

toJSON :: SqlSerial a -> Value

toEncoding :: SqlSerial a -> Encoding

toJSONList :: [SqlSerial a] -> Value

toEncodingList :: [SqlSerial a] -> Encoding

FromJSON a => FromJSON (SqlSerial a)

Methods

parseJSON :: Value -> Parser (SqlSerial a)

parseJSONList :: Value -> Parser [SqlSerial a]