Database.Beam.Query.Types

Documentation

data Q syntax (db :: (* -> *) -> *) s a

The type of queries over the database db returning results of type a. The s argument is a threading argument meant to restrict cross-usage of QExprs. syntax represents the SQL syntax that this query is building.

Instances

Monad (Q syntax db s)

Methods

(>>=) :: Q syntax db s a -> (a -> Q syntax db s b) -> Q syntax db s b

(>>) :: Q syntax db s a -> Q syntax db s b -> Q syntax db s b

return :: a -> Q syntax db s a

fail :: String -> Q syntax db s a

Functor (Q syntax db s)

Methods

fmap :: (a -> b) -> Q syntax db s a -> Q syntax db s b

(<$) :: a -> Q syntax db s b -> Q syntax db s a

Applicative (Q syntax db s)

Methods

pure :: a -> Q syntax db s a

(<*>) :: Q syntax db s (a -> b) -> Q syntax db s a -> Q syntax db s b

liftA2 :: (a -> b -> c) -> Q syntax db s a -> Q syntax db s b -> Q syntax db s c

(*>) :: Q syntax db s a -> Q syntax db s b -> Q syntax db s b

(<*) :: Q syntax db s a -> Q syntax db s b -> Q syntax db s a

type QExpr = QGenExpr QValueContext

QExprs represent expressions not containing aggregates.

newtype QGenExpr context syntax s t

The type of lifted beam expressions that will yield the haskell type t.

context is a type-level representation of the types of expressions this can contain. For example, QAggregateContext represents expressions that may contain aggregates, and QWindowingContext represents expressions that may contain OVER.

syntax is the expression syntax being built (usually a type that implements IsSql92ExpressionSyntax at least, but not always).

s is a state threading parameter that prevents QExprs from incompatible sources to be combined. For example, this is used to prevent monadic joins from depending on the result of previous joins (so-called LATERAL joins).

Constructors

QExpr (TablePrefix -> syntax)

Instances

(Beamable t, contextPredicate context) => ProjectibleWithPredicate contextPredicate syntax (t (Nullable (QGenExpr context syntax s)))

Methods

project' :: Monad m => Proxy (* -> Constraint) contextPredicate -> (forall context0. contextPredicate context0 => Proxy * context0 -> WithExprContext syntax -> m (WithExprContext syntax)) -> t (Nullable (QGenExpr context syntax s)) -> m (t (Nullable (QGenExpr context syntax s)))

(Beamable t, contextPredicate context) => ProjectibleWithPredicate contextPredicate syntax (t (QGenExpr context syntax s))

Methods

project' :: Monad m => Proxy (* -> Constraint) contextPredicate -> (forall context0. contextPredicate context0 => Proxy * context0 -> WithExprContext syntax -> m (WithExprContext syntax)) -> t (QGenExpr context syntax s) -> m (t (QGenExpr context syntax s))

contextPredicate context => ProjectibleWithPredicate contextPredicate syntax (QGenExpr context syntax s a)

Methods

project' :: Monad m => Proxy (* -> Constraint) contextPredicate -> (forall context0. contextPredicate context0 => Proxy * context0 -> WithExprContext syntax -> m (WithExprContext syntax)) -> QGenExpr context syntax s a -> m (QGenExpr context syntax s a)

Beamable tbl => ThreadRewritable s (tbl (Nullable (QGenExpr ctxt syntax s)))

Associated Types

type WithRewrittenThread s s' (tbl (Nullable (QGenExpr ctxt syntax s))) :: *

Methods

rewriteThread :: Proxy * s' -> tbl (Nullable (QGenExpr ctxt syntax s)) -> WithRewrittenThread s s' (tbl (Nullable (QGenExpr ctxt syntax s)))

Beamable tbl => ThreadRewritable s (tbl (QGenExpr ctxt syntax s))

Associated Types

type WithRewrittenThread s s' (tbl (QGenExpr ctxt syntax s)) :: *

Methods

rewriteThread :: Proxy * s' -> tbl (QGenExpr ctxt syntax s) -> WithRewrittenThread s s' (tbl (QGenExpr ctxt syntax s))

(IsSql92ExpressionSyntax syntax, HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) Bool, Beamable t) => SqlDeconstructMaybe syntax (t (Nullable (QGenExpr ctxt syntax s))) (t (QGenExpr ctxt syntax s)) s

Methods

isJust_ :: t (Nullable (QGenExpr ctxt syntax s)) -> QGenExpr ctxt syntax s Bool

isNothing_ :: t (Nullable (QGenExpr ctxt syntax s)) -> QGenExpr ctxt syntax s Bool

maybe_ :: QGenExpr ctxt syntax s y -> (t (QGenExpr ctxt syntax s) -> QGenExpr ctxt syntax s y) -> t (Nullable (QGenExpr ctxt syntax s)) -> QGenExpr ctxt syntax s y

SqlOrderable syntax (QOrd syntax s a)

Methods

makeSQLOrdering :: QOrd syntax s a -> [WithExprContext syntax]

ThreadRewritable s (QGenExpr ctxt syntax s a)

Associated Types

type WithRewrittenThread s s' (QGenExpr ctxt syntax s a) :: *

Methods

rewriteThread :: Proxy * s' -> QGenExpr ctxt syntax s a -> WithRewrittenThread s s' (QGenExpr ctxt syntax s a)

IsSql92ExpressionSyntax syntax => SqlDeconstructMaybe syntax (QGenExpr ctxt syntax s (Maybe x)) (QGenExpr ctxt syntax s x) s

Methods

isJust_ :: QGenExpr ctxt syntax s (Maybe x) -> QGenExpr ctxt syntax s Bool

isNothing_ :: QGenExpr ctxt syntax s (Maybe x) -> QGenExpr ctxt syntax s Bool

maybe_ :: QGenExpr ctxt syntax s y -> (QGenExpr ctxt syntax s x -> QGenExpr ctxt syntax s y) -> QGenExpr ctxt syntax s (Maybe x) -> QGenExpr ctxt syntax s y

Beamable tbl => ContextRewritable (tbl (Nullable (QGenExpr old syntax s)))

Associated Types

type WithRewrittenContext (tbl (Nullable (QGenExpr old syntax s))) ctxt :: *

Methods

rewriteContext :: Proxy * ctxt -> tbl (Nullable (QGenExpr old syntax s)) -> WithRewrittenContext (tbl (Nullable (QGenExpr old syntax s))) ctxt

Beamable tbl => ContextRewritable (tbl (QGenExpr old syntax s))

Associated Types

type WithRewrittenContext (tbl (QGenExpr old syntax s)) ctxt :: *

Methods

rewriteContext :: Proxy * ctxt -> tbl (QGenExpr old syntax s) -> WithRewrittenContext (tbl (QGenExpr old syntax s)) ctxt

(Beamable table, IsSql92ExpressionSyntax syntax, FieldsFulfillConstraintNullable (HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax)) table) => SqlValable (table (Nullable (QGenExpr ctxt syntax s)))

Methods

val_ :: HaskellLiteralForQExpr (table (Nullable (QGenExpr ctxt syntax s))) -> table (Nullable (QGenExpr ctxt syntax s))

(Beamable table, IsSql92ExpressionSyntax syntax, FieldsFulfillConstraint (HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax)) table) => SqlValable (table (QGenExpr ctxt syntax s))

Methods

val_ :: HaskellLiteralForQExpr (table (QGenExpr ctxt syntax s)) -> table (QGenExpr ctxt syntax s)

(Table t, IsSql92ExpressionSyntax syntax, HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) SqlNull) => SqlJustable (t (QExpr syntax s)) (t (Nullable (QExpr syntax s)))

Methods

just_ :: t (QExpr syntax s) -> t (Nullable (QExpr syntax s))

nothing_ :: t (Nullable (QExpr syntax s))

Beamable tbl => QGroupable (tbl (QExpr expr s)) (tbl (QGroupExpr expr s))

group_ for any Beamable type. Adds every field in the type to the grouping key. This is the equivalent of including the grouping expression of each field in the type as part of the aggregate projection

Methods

group_ :: tbl (QExpr expr s) -> tbl (QGroupExpr expr s)

(Table t, IsSql92ExpressionSyntax syntax, HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) SqlNull) => SqlJustable (PrimaryKey t (QExpr syntax s)) (PrimaryKey t (Nullable (QExpr syntax s)))

Methods

just_ :: PrimaryKey t (QExpr syntax s) -> PrimaryKey t (Nullable (QExpr syntax s))

nothing_ :: PrimaryKey t (Nullable (QExpr syntax s))

(IsSql92ExpressionSyntax syntax, FieldsFulfillConstraintNullable (HasSqlEqualityCheck syntax) tbl, HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) Bool, Beamable tbl) => SqlEq (QGenExpr context syntax s) (tbl (Nullable (QGenExpr context syntax s)))

Methods

(==.) :: tbl (Nullable (QGenExpr context syntax s)) -> tbl (Nullable (QGenExpr context syntax s)) -> QGenExpr context syntax s Bool

(/=.) :: tbl (Nullable (QGenExpr context syntax s)) -> tbl (Nullable (QGenExpr context syntax s)) -> QGenExpr context syntax s Bool

(==?.) :: tbl (Nullable (QGenExpr context syntax s)) -> tbl (Nullable (QGenExpr context syntax s)) -> QGenExpr context syntax s SqlBool

(/=?.) :: tbl (Nullable (QGenExpr context syntax s)) -> tbl (Nullable (QGenExpr context syntax s)) -> QGenExpr context syntax s SqlBool

(IsSql92ExpressionSyntax syntax, FieldsFulfillConstraint (HasSqlEqualityCheck syntax) tbl, HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) Bool, Beamable tbl) => SqlEq (QGenExpr context syntax s) (tbl (QGenExpr context syntax s))

Compare two arbitrary Beamable types containing QGenExprs for equality.

Methods

(==.) :: tbl (QGenExpr context syntax s) -> tbl (QGenExpr context syntax s) -> QGenExpr context syntax s Bool

(/=.) :: tbl (QGenExpr context syntax s) -> tbl (QGenExpr context syntax s) -> QGenExpr context syntax s Bool

(==?.) :: tbl (QGenExpr context syntax s) -> tbl (QGenExpr context syntax s) -> QGenExpr context syntax s SqlBool

(/=?.) :: tbl (QGenExpr context syntax s) -> tbl (QGenExpr context syntax s) -> QGenExpr context syntax s SqlBool

(IsSql92ExpressionSyntax syntax, HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) SqlNull) => SqlJustable (QExpr syntax s a) (QExpr syntax s (Maybe a))

Methods

just_ :: QExpr syntax s a -> QExpr syntax s (Maybe a)

nothing_ :: QExpr syntax s (Maybe a)

QGroupable (QExpr expr s a) (QGroupExpr expr s a)

group_ for simple value expressions.

Methods

group_ :: QExpr expr s a -> QGroupExpr expr s a

IsSql92ExpressionSyntax syntax => SqlOrdQuantified (QGenExpr context syntax s) (QQuantified syntax s a) (QGenExpr context syntax s a)

Methods

(<*.) :: QGenExpr context syntax s a -> QQuantified syntax s a -> QGenExpr context syntax s Bool

(>*.) :: QGenExpr context syntax s a -> QQuantified syntax s a -> QGenExpr context syntax s Bool

(<=*.) :: QGenExpr context syntax s a -> QQuantified syntax s a -> QGenExpr context syntax s Bool

(>=*.) :: QGenExpr context syntax s a -> QQuantified syntax s a -> QGenExpr context syntax s Bool

(IsSql92ExpressionSyntax syntax, HasSqlQuantifiedEqualityCheck syntax a) => SqlEqQuantified (QGenExpr context syntax s) (QQuantified syntax s a) (QGenExpr context syntax s a)

Two arbitrary expressions can be quantifiably compared for equality.

Methods

(==*.) :: QGenExpr context syntax s a -> QQuantified syntax s a -> QGenExpr context syntax s SqlBool

(/=*.) :: QGenExpr context syntax s a -> QQuantified syntax s a -> QGenExpr context syntax s SqlBool

Retaggable (QGenExpr ctxt expr s) (QGenExpr ctxt expr s t)

Associated Types

type Retag (tag :: (* -> *) -> * -> *) (QGenExpr ctxt expr s t) :: *

Methods

retag :: (forall a. Columnar' (QGenExpr ctxt expr s) a -> Columnar' (tag (QGenExpr ctxt expr s)) a) -> QGenExpr ctxt expr s t -> Retag tag (QGenExpr ctxt expr s t)

IsSql92ExpressionSyntax syntax => SqlOrd (QGenExpr context syntax s) (QGenExpr context syntax s a)

Methods

(<.) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s Bool

(>.) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s Bool

(<=.) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s Bool

(>=.) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s Bool

(IsSql92ExpressionSyntax syntax, HasSqlEqualityCheck syntax a) => SqlEq (QGenExpr context syntax s) (QGenExpr context syntax s a)

Compare two arbitrary expressions (of the same type) for equality

Methods

(==.) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s Bool

(/=.) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s Bool

(==?.) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s SqlBool

(/=?.) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s SqlBool

Eq syntax => Eq (QGenExpr context syntax s t)

Methods

(==) :: QGenExpr context syntax s t -> QGenExpr context syntax s t -> Bool

(/=) :: QGenExpr context syntax s t -> QGenExpr context syntax s t -> Bool

(Fractional a, IsSql92ExpressionSyntax syntax, HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) a) => Fractional (QGenExpr context syntax s a)

Methods

(/) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s a

recip :: QGenExpr context syntax s a -> QGenExpr context syntax s a

fromRational :: Rational -> QGenExpr context syntax s a

(Num a, IsSql92ExpressionSyntax syntax, HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) a) => Num (QGenExpr context syntax s a)

Methods

(+) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s a

(-) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s a

(*) :: QGenExpr context syntax s a -> QGenExpr context syntax s a -> QGenExpr context syntax s a

negate :: QGenExpr context syntax s a -> QGenExpr context syntax s a

abs :: QGenExpr context syntax s a -> QGenExpr context syntax s a

signum :: QGenExpr context syntax s a -> QGenExpr context syntax s a

fromInteger :: Integer -> QGenExpr context syntax s a

(IsSql92ExpressionSyntax syntax, HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) [Char]) => IsString (QGenExpr context syntax s Text)

Methods

fromString :: String -> QGenExpr context syntax s Text

ContextRewritable (QGenExpr old syntax s a)

Associated Types

type WithRewrittenContext (QGenExpr old syntax s a) ctxt :: *

Methods

rewriteContext :: Proxy * ctxt -> QGenExpr old syntax s a -> WithRewrittenContext (QGenExpr old syntax s a) ctxt

(HasSqlValueSyntax (Sql92ExpressionValueSyntax syntax) a, IsSql92ExpressionSyntax syntax) => SqlValable (QGenExpr ctxt syntax s a)

Methods

val_ :: HaskellLiteralForQExpr (QGenExpr ctxt syntax s a) -> QGenExpr ctxt syntax s a

type WithRewrittenThread s s' (tbl (Nullable (QGenExpr ctxt syntax s)))

type WithRewrittenThread s s' (tbl (Nullable (QGenExpr ctxt syntax s))) = tbl (Nullable (QGenExpr ctxt syntax s'))

type WithRewrittenThread s s' (tbl (QGenExpr ctxt syntax s))

type WithRewrittenThread s s' (tbl (QGenExpr ctxt syntax s)) = tbl (QGenExpr ctxt syntax s')

type WithRewrittenThread s s' (QGenExpr ctxt syntax s a)

type WithRewrittenThread s s' (QGenExpr ctxt syntax s a) = QGenExpr ctxt syntax s' a

type Retag tag (QGenExpr ctxt expr s t)

type Retag tag (QGenExpr ctxt expr s t) = Columnar (tag (QGenExpr ctxt expr s)) t

type QExprToField (table (Nullable (QGenExpr context syntax s)))

type QExprToField (table (Nullable (QGenExpr context syntax s))) = table (Nullable (QField s))

type QExprToField (table (QGenExpr context syntax s))

type QExprToField (table (QGenExpr context syntax s)) = table (QField s)

type QExprToIdentity (table (QGenExpr context syntax s))

type QExprToIdentity (table (QGenExpr context syntax s)) = table Identity

type HaskellLiteralForQExpr (table (QGenExpr context syntax s))

type HaskellLiteralForQExpr (table (QGenExpr context syntax s)) = table Identity

type WithRewrittenContext (tbl (Nullable (QGenExpr old syntax s))) ctxt

type WithRewrittenContext (tbl (Nullable (QGenExpr old syntax s))) ctxt = tbl (Nullable (QGenExpr ctxt syntax s))

type WithRewrittenContext (tbl (QGenExpr old syntax s)) ctxt

type WithRewrittenContext (tbl (QGenExpr old syntax s)) ctxt = tbl (QGenExpr ctxt syntax s)

type QExprToField (QGenExpr ctxt syntax s a)

type QExprToField (QGenExpr ctxt syntax s a) = QField s a

type QExprToIdentity (QGenExpr context syntax s a)

type QExprToIdentity (QGenExpr context syntax s a) = a

type HaskellLiteralForQExpr (QGenExpr context syntax s a)

type HaskellLiteralForQExpr (QGenExpr context syntax s a) = a

type WithRewrittenContext (QGenExpr old syntax s a) ctxt

type WithRewrittenContext (QGenExpr old syntax s a) ctxt = QGenExpr ctxt syntax s a

type family QExprToIdentity x

Instances

type QExprToIdentity ()

type QExprToIdentity () = ()

type QExprToIdentity (table (Nullable c))

type QExprToIdentity (table (Nullable c)) = Maybe (QExprToIdentity (table c))

type QExprToIdentity (table (QGenExpr context syntax s))

type QExprToIdentity (table (QGenExpr context syntax s)) = table Identity

type QExprToIdentity (a, b)

type QExprToIdentity (a, b) = (QExprToIdentity a, QExprToIdentity b)

type QExprToIdentity (Vector n a)

type QExprToIdentity (Vector n a) = Vector n (QExprToIdentity a)

type QExprToIdentity (a, b, c)

type QExprToIdentity (a, b, c) = (QExprToIdentity a, QExprToIdentity b, QExprToIdentity c)

type QExprToIdentity (a, b, c, d)

type QExprToIdentity (a, b, c, d) = (QExprToIdentity a, QExprToIdentity b, QExprToIdentity c, QExprToIdentity d)

type QExprToIdentity (QGenExpr context syntax s a)

type QExprToIdentity (QGenExpr context syntax s a) = a

type QExprToIdentity (a, b, c, d, e)

type QExprToIdentity (a, b, c, d, e) = (QExprToIdentity a, QExprToIdentity b, QExprToIdentity c, QExprToIdentity d, QExprToIdentity e)

type QExprToIdentity (a, b, c, d, e, f)

type QExprToIdentity (a, b, c, d, e, f) = (QExprToIdentity a, QExprToIdentity b, QExprToIdentity c, QExprToIdentity d, QExprToIdentity e, QExprToIdentity f)

type QExprToIdentity (a, b, c, d, e, f, g)

type QExprToIdentity (a, b, c, d, e, f, g) = (QExprToIdentity a, QExprToIdentity b, QExprToIdentity c, QExprToIdentity d, QExprToIdentity e, QExprToIdentity f, QExprToIdentity g)

type QExprToIdentity (a, b, c, d, e, f, g, h)

type QExprToIdentity (a, b, c, d, e, f, g, h) = (QExprToIdentity a, QExprToIdentity b, QExprToIdentity c, QExprToIdentity d, QExprToIdentity e, QExprToIdentity f, QExprToIdentity g, QExprToIdentity h)

type family QExprToField x

Instances

type QExprToField ()

type QExprToField () = ()

type QExprToField (table (Nullable (QGenExpr context syntax s)))

type QExprToField (table (Nullable (QGenExpr context syntax s))) = table (Nullable (QField s))

type QExprToField (table (QGenExpr context syntax s))

type QExprToField (table (QGenExpr context syntax s)) = table (QField s)

type QExprToField (a, b)

type QExprToField (a, b) = (QExprToField a, QExprToField b)

type QExprToField (Vector n a)

type QExprToField (Vector n a) = Vector n (QExprToField a)

type QExprToField (a, b, c)

type QExprToField (a, b, c) = (QExprToField a, QExprToField b, QExprToField c)

type QExprToField (a, b, c, d)

type QExprToField (a, b, c, d) = (QExprToField a, QExprToField b, QExprToField c, QExprToField d)

type QExprToField (QGenExpr ctxt syntax s a)

type QExprToField (QGenExpr ctxt syntax s a) = QField s a

type QExprToField (a, b, c, d, e)

type QExprToField (a, b, c, d, e) = (QExprToField a, QExprToField b, QExprToField c, QExprToField d, QExprToField e)

type QExprToField (a, b, c, d, e, f)

type QExprToField (a, b, c, d, e, f) = (QExprToField a, QExprToField b, QExprToField c, QExprToField d, QExprToField e, QExprToField f)

type QExprToField (a, b, c, d, e, f, g)

type QExprToField (a, b, c, d, e, f, g) = (QExprToField a, QExprToField b, QExprToField c, QExprToField d, QExprToField e, QExprToField f, QExprToField g)

type QExprToField (a, b, c, d, e, f, g, h)

type QExprToField (a, b, c, d, e, f, g, h) = (QExprToField a, QExprToField b, QExprToField c, QExprToField d, QExprToField e, QExprToField f, QExprToField g, QExprToField h)

data QWindow syntax s

Instances

ProjectibleWithPredicate WindowFrameContext syntax (QWindow syntax s)

Methods

project' :: Monad m => Proxy (* -> Constraint) WindowFrameContext -> (forall context. WindowFrameContext context => Proxy * context -> WithExprContext syntax -> m (WithExprContext syntax)) -> QWindow syntax s -> m (QWindow syntax s)

type QWindowFrame = QGenExpr QWindowFrameContext

type Projectible = ProjectibleWithPredicate AnyType

data Aggregation syntax s a

class IsSql92SelectSyntax selectSyntax => HasQBuilder selectSyntax where

Minimal complete definition

buildSqlQuery

Methods

buildSqlQuery :: Projectible (Sql92SelectExpressionSyntax selectSyntax) a => TablePrefix -> Q selectSyntax db s a -> selectSyntax

Instances

HasQBuilder Select

Methods

buildSqlQuery :: Projectible (Sql92SelectExpressionSyntax Select) a => TablePrefix -> Q Select db s a -> Select

HasQBuilder SqlSyntaxBuilder

Methods

buildSqlQuery :: Projectible (Sql92SelectExpressionSyntax SqlSyntaxBuilder) a => TablePrefix -> Q SqlSyntaxBuilder db s a -> SqlSyntaxBuilder