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 be m => MonadBeamInsertReturning be m | m -> be where

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

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> m [table Identity]

Instances

MonadBeamInsertReturning be m => MonadBeamInsertReturning be (ExceptT e m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> ExceptT e m [table Identity]

MonadBeamInsertReturning be m => MonadBeamInsertReturning be (ReaderT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> ReaderT r m [table Identity]

MonadBeamInsertReturning be m => MonadBeamInsertReturning be (StateT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> StateT r m [table Identity]

MonadBeamInsertReturning be m => MonadBeamInsertReturning be (StateT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> StateT r m [table Identity]

(MonadBeamInsertReturning be m, Monoid r) => MonadBeamInsertReturning be (WriterT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> WriterT r m [table Identity]

(MonadBeamInsertReturning be m, Monoid r) => MonadBeamInsertReturning be (WriterT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> WriterT r m [table Identity]

MonadBeamInsertReturning be m => MonadBeamInsertReturning be (ContT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> ContT r m [table Identity]

(MonadBeamInsertReturning be m, Monoid w) => MonadBeamInsertReturning be (RWST r w s m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> RWST r w s m [table Identity]

(MonadBeamInsertReturning be m, Monoid w) => MonadBeamInsertReturning be (RWST r w s m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runInsertReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlInsert be table -> RWST r w s m [table Identity]

class MonadBeam be m => MonadBeamUpdateReturning be m | m -> be where

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

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> m [table Identity]

Instances

MonadBeamUpdateReturning be m => MonadBeamUpdateReturning be (ExceptT e m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> ExceptT e m [table Identity]

MonadBeamUpdateReturning be m => MonadBeamUpdateReturning be (ReaderT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> ReaderT r m [table Identity]

MonadBeamUpdateReturning be m => MonadBeamUpdateReturning be (StateT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> StateT r m [table Identity]

MonadBeamUpdateReturning be m => MonadBeamUpdateReturning be (StateT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> StateT r m [table Identity]

(MonadBeamUpdateReturning be m, Monoid r) => MonadBeamUpdateReturning be (WriterT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> WriterT r m [table Identity]

(MonadBeamUpdateReturning be m, Monoid r) => MonadBeamUpdateReturning be (WriterT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> WriterT r m [table Identity]

MonadBeamUpdateReturning be m => MonadBeamUpdateReturning be (ContT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> ContT r m [table Identity]

(MonadBeamUpdateReturning be m, Monoid w) => MonadBeamUpdateReturning be (RWST r w s m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> RWST r w s m [table Identity]

(MonadBeamUpdateReturning be m, Monoid w) => MonadBeamUpdateReturning be (RWST r w s m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runUpdateReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlUpdate be table -> RWST r w s m [table Identity]

class MonadBeam be m => MonadBeamDeleteReturning be m | m -> be 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.

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> m [table Identity]

Instances

MonadBeamDeleteReturning be m => MonadBeamDeleteReturning be (ExceptT e m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> ExceptT e m [table Identity]

MonadBeamDeleteReturning be m => MonadBeamDeleteReturning be (ReaderT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> ReaderT r m [table Identity]

MonadBeamDeleteReturning be m => MonadBeamDeleteReturning be (StateT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> StateT r m [table Identity]

MonadBeamDeleteReturning be m => MonadBeamDeleteReturning be (StateT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> StateT r m [table Identity]

(MonadBeamDeleteReturning be m, Monoid r) => MonadBeamDeleteReturning be (WriterT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> WriterT r m [table Identity]

(MonadBeamDeleteReturning be m, Monoid r) => MonadBeamDeleteReturning be (WriterT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> WriterT r m [table Identity]

MonadBeamDeleteReturning be m => MonadBeamDeleteReturning be (ContT r m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> ContT r m [table Identity]

(MonadBeamDeleteReturning be m, Monoid w) => MonadBeamDeleteReturning be (RWST r w s m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> RWST r w s m [table Identity]

(MonadBeamDeleteReturning be m, Monoid w) => MonadBeamDeleteReturning be (RWST r w s m)

Defined in Database.Beam.Backend.SQL.BeamExtensions

Methods

runDeleteReturningList :: (Beamable table, Projectible be (table (QExpr be ())), FromBackendRow be (table Identity)) => SqlDelete be table -> RWST r w s m [table Identity]

class BeamSqlBackend be => BeamHasInsertOnConflict be where

Associated Types

data SqlConflictTarget be (table :: (Type -> Type) -> Type) :: Type

Specifies the kind of constraint that must be violated for the action to occur

data SqlConflictAction be (table :: (Type -> Type) -> Type) :: Type

What to do when an INSERT statement inserts a row into the table tbl that violates a constraint.

Methods

insertOnConflict :: Beamable table => DatabaseEntity be db (TableEntity table) -> SqlInsertValues be (table (QExpr be s)) -> SqlConflictTarget be table -> SqlConflictAction be table -> SqlInsert be table

anyConflict :: SqlConflictTarget be table

conflictingFields :: Projectible be proj => (table (QExpr be QInternal) -> proj) -> SqlConflictTarget be table

conflictingFieldsWhere :: Projectible be proj => (table (QExpr be QInternal) -> proj) -> (forall s. table (QExpr be s) -> QExpr be s Bool) -> SqlConflictTarget be table

onConflictDoNothing :: SqlConflictAction be table

onConflictUpdateSet :: Beamable table => (forall s. table (QField s) -> table (QExpr be s) -> QAssignment be s) -> SqlConflictAction be table

onConflictUpdateSetWhere :: Beamable table => (forall s. table (QField s) -> table (QExpr be s) -> QAssignment be s) -> (forall s. table (QField s) -> table (QExpr be s) -> QExpr be s Bool) -> SqlConflictAction be table

newtype SqlSerial a

Constructors

SqlSerial

Fields

• unSerial :: a

Instances

FromBackendRow be x => FromBackendRow be (SqlSerial x)

Defined in Database.Beam.Backend.SQL.Row

Methods

fromBackendRow :: FromBackendRowM be (SqlSerial x)

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

HasSqlValueSyntax syntax x => HasSqlValueSyntax syntax (SqlSerial x)

Defined in Database.Beam.Backend.SQL.SQL92

Methods

sqlValueSyntax :: SqlSerial x -> syntax

HasSqlEqualityCheck be a => HasSqlEqualityCheck be (SqlSerial a)

Defined in Database.Beam.Query.Ord

Methods

sqlEqE :: Proxy (SqlSerial a) -> Proxy be -> BeamSqlBackendExpressionSyntax be -> BeamSqlBackendExpressionSyntax be -> BeamSqlBackendExpressionSyntax be

sqlNeqE :: Proxy (SqlSerial a) -> Proxy be -> BeamSqlBackendExpressionSyntax be -> BeamSqlBackendExpressionSyntax be -> BeamSqlBackendExpressionSyntax be

sqlEqTriE :: Proxy (SqlSerial a) -> Proxy be -> BeamSqlBackendExpressionSyntax be -> BeamSqlBackendExpressionSyntax be -> BeamSqlBackendExpressionSyntax be

sqlNeqTriE :: Proxy (SqlSerial a) -> Proxy be -> BeamSqlBackendExpressionSyntax be -> BeamSqlBackendExpressionSyntax be -> BeamSqlBackendExpressionSyntax be

HasSqlQuantifiedEqualityCheck syntax a => HasSqlQuantifiedEqualityCheck syntax (SqlSerial a)

Defined in Database.Beam.Query.Ord

Methods

sqlQEqE :: Proxy (SqlSerial a) -> Proxy syntax -> Maybe (BeamSqlBackendExpressionQuantifierSyntax syntax) -> BeamSqlBackendExpressionSyntax syntax -> BeamSqlBackendExpressionSyntax syntax -> BeamSqlBackendExpressionSyntax syntax

sqlQNeqE :: Proxy (SqlSerial a) -> Proxy syntax -> Maybe (BeamSqlBackendExpressionQuantifierSyntax syntax) -> BeamSqlBackendExpressionSyntax syntax -> BeamSqlBackendExpressionSyntax syntax -> BeamSqlBackendExpressionSyntax syntax

FromJSON a => FromJSON (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

Methods

parseJSON :: Value -> Parser (SqlSerial a)

parseJSONList :: Value -> Parser [SqlSerial a]

omittedField :: Maybe (SqlSerial a)

ToJSON a => ToJSON (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

Methods

toJSON :: SqlSerial a -> Value

toEncoding :: SqlSerial a -> Encoding

toJSONList :: [SqlSerial a] -> Value

toEncodingList :: [SqlSerial a] -> Encoding

omitField :: SqlSerial a -> Bool

Enum a => Enum (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

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]

Num a => Num (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

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

Read a => Read (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

Methods

readsPrec :: Int -> ReadS (SqlSerial a)

readList :: ReadS [SqlSerial a]

readPrec :: ReadPrec (SqlSerial a)

readListPrec :: ReadPrec [SqlSerial a]

Integral a => Integral (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

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

Real a => Real (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

Methods

toRational :: SqlSerial a -> Rational

Show a => Show (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

Methods

showsPrec :: Int -> SqlSerial a -> ShowS

show :: SqlSerial a -> String

showList :: [SqlSerial a] -> ShowS

Eq a => Eq (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

Methods

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

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

Ord a => Ord (SqlSerial a)

Defined in Database.Beam.Backend.SQL.Types

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

onConflictUpdateInstead :: forall be table proj. (BeamHasInsertOnConflict be, Beamable table, ProjectibleWithPredicate AnyType () (InaccessibleQAssignment be) proj) => (table (Const (InaccessibleQAssignment be)) -> proj) -> SqlConflictAction be table

onConflictUpdateAll :: forall be table. (BeamHasInsertOnConflict be, Beamable table) => SqlConflictAction be table