Copyright	(c) digitally induced GmbH 2020
Safe Haskell	None
Language	GHC2021

IHP.QueryBuilder.Types

Contents

Core Types
Helpers
Type Classes

Description

Synopsis

newtype QueryBuilder (table :: Symbol) = QueryBuilder {
- unQueryBuilder :: SQLQuery
}
data SQLQuery = SQLQuery {
- selectFrom :: !Text
- distinctClause :: !Bool
- distinctOnClause :: !(Maybe Text)
- whereCondition :: !(Maybe Condition)
- orderByClause :: ![OrderByClause]
- limitClause :: !(Maybe Int)
- offsetClause :: !(Maybe Int)
- columns :: ![Text]
- columnsSql :: !Text
}
data Condition
- = ColumnCondition !Text !FilterOperator !ConditionValue !(Maybe Text) !(Maybe Text)
- | OrCondition !Condition !Condition
- | AndCondition !Condition !Condition
data ConditionValue
- = Param !(Params ())
- | Literal !Text
data OrderByClause = OrderByClause {
- orderByColumn :: !Text
- orderByDirection :: !OrderByDirection
}
data OrderByDirection
- = Asc
- | Desc
data FilterOperator
- = EqOp
- | NotEqOp
- | InOp
- | NotInOp
- | IsOp
- | IsNotOp
- | LikeOp !MatchSensitivity
- | NotLikeOp !MatchSensitivity
- | MatchesOp !MatchSensitivity
- | GreaterThanOp
- | GreaterThanOrEqualToOp
- | LessThanOp
- | LessThanOrEqualToOp
- | SqlOp
data MatchSensitivity
- = CaseSensitive
- | CaseInsensitive
addCondition :: forall (table :: Symbol). Condition -> QueryBuilder table -> QueryBuilder table
qualifyAndJoinColumns :: Text -> [Text] -> Text
class DefaultScope (table :: Symbol) where
- defaultScope :: QueryBuilder table -> QueryBuilder table
class EqOrIsOperator value where
- toEqOrIsOperator :: value -> FilterOperator
class FilterPrimaryKey (table :: Symbol) where
- filterWhereId :: Id' table -> QueryBuilder table -> QueryBuilder table

Core Types

newtype QueryBuilder (table :: Symbol) Source #

The QueryBuilder is a flat newtype over SQLQuery. Each combinator directly modifies fields of the underlying SQLQuery, avoiding any recursive tree traversal.

Constructors

QueryBuilder
Fields unQueryBuilder :: SQLQuery

Instances

Instances details

Table (GetModelByTableName table) => Default (QueryBuilder table) Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

def :: QueryBuilder table Source #

Show (QueryBuilder table) Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

showsPrec :: Int -> QueryBuilder table -> ShowS #

show :: QueryBuilder table -> String #

showList :: [QueryBuilder table] -> ShowS #

Eq (QueryBuilder table) Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

(==) :: QueryBuilder table -> QueryBuilder table -> Bool #

(/=) :: QueryBuilder table -> QueryBuilder table -> Bool #

KnownSymbol table => ToHtml (QueryBuilder table) Source #

Display QueryBuilder's as their sql query inside HSX

Instance details

Defined in IHP.QueryBuilder.Types

Methods

toHtml :: QueryBuilder table -> Markup

(model ~ GetModelByTableName table, KnownSymbol table) => Fetchable (QueryBuilder table) model Source #

Instance details

Defined in IHP.Fetch

Associated Types

type FetchResult (QueryBuilder table) model
Instance details Defined in IHP.Fetch type FetchResult (QueryBuilder table) model = [model]

Methods

fetch :: QueryBuilder table -> IO (FetchResult (QueryBuilder table) model) Source #

fetchOneOrNothing :: QueryBuilder table -> IO (Maybe model) Source #

fetchOne :: QueryBuilder table -> IO model Source #

type FetchResult (QueryBuilder table) model Source #

Instance details

Defined in IHP.Fetch

type FetchResult (QueryBuilder table) model = [model]

data SQLQuery Source #

Represents a complete SQL query after building

Constructors

SQLQuery

Fields

selectFrom :: !Text
distinctClause :: !Bool
distinctOnClause :: !(Maybe Text)
whereCondition :: !(Maybe Condition)
orderByClause :: ![OrderByClause]
limitClause :: !(Maybe Int)
offsetClause :: !(Maybe Int)
columns :: ![Text]
columnsSql :: !Text
Pre-computed qualified column selector, e.g. "users.id, users.name". Built once at query construction time so the compiler avoids re-qualifying and re-joining the column list on every compilation.

Instances

Instances details

Show SQLQuery Source #
Instance details Defined in IHP.QueryBuilder.Types Methods showsPrec :: Int -> SQLQuery -> ShowS # show :: SQLQuery -> String # showList :: [SQLQuery] -> ShowS #
SetField "distinctClause" SQLQuery Bool Source #
Instance details Defined in IHP.QueryBuilder.Types Methods setField :: Bool -> SQLQuery -> SQLQuery Source #
SetField "selectFrom" SQLQuery Text Source #
Instance details Defined in IHP.QueryBuilder.Types Methods setField :: Text -> SQLQuery -> SQLQuery Source #
SetField "distinctOnClause" SQLQuery (Maybe Text) Source #
Instance details Defined in IHP.QueryBuilder.Types Methods setField :: Maybe Text -> SQLQuery -> SQLQuery Source #
SetField "limitClause" SQLQuery (Maybe Int) Source #
Instance details Defined in IHP.QueryBuilder.Types Methods setField :: Maybe Int -> SQLQuery -> SQLQuery Source #
SetField "offsetClause" SQLQuery (Maybe Int) Source #
Instance details Defined in IHP.QueryBuilder.Types Methods setField :: Maybe Int -> SQLQuery -> SQLQuery Source #
SetField "orderByClause" SQLQuery [OrderByClause] Source #
Instance details Defined in IHP.QueryBuilder.Types Methods setField :: [OrderByClause] -> SQLQuery -> SQLQuery Source #
SetField "whereCondition" SQLQuery (Maybe Condition) Source #
Instance details Defined in IHP.QueryBuilder.Types Methods setField :: Maybe Condition -> SQLQuery -> SQLQuery Source #

data Condition Source #

Represents a WHERE condition

Constructors

ColumnCondition !Text !FilterOperator !ConditionValue !(Maybe Text) !(Maybe Text)
OrCondition !Condition !Condition
AndCondition !Condition !Condition

Instances

Instances details

Show Condition Source #
Instance details Defined in IHP.QueryBuilder.Types Methods showsPrec :: Int -> Condition -> ShowS # show :: Condition -> String # showList :: [Condition] -> ShowS #
Eq Condition Source #
Instance details Defined in IHP.QueryBuilder.Types Methods (==) :: Condition -> Condition -> Bool # (/=) :: Condition -> Condition -> Bool #
SetField "whereCondition" SQLQuery (Maybe Condition) Source #
Instance details Defined in IHP.QueryBuilder.Types Methods setField :: Maybe Condition -> SQLQuery -> SQLQuery Source #

data ConditionValue Source #

A condition value: either a parameterized encoder or a literal SQL fragment.

Constructors

Param !(Params ())	Parameterized value: compiler assigns $N
Literal !Text	Raw SQL text (for filterWhereSql, NULL comparisons, etc.)

Instances

Instances details

Show ConditionValue Source #
Instance details Defined in IHP.QueryBuilder.Types Methods showsPrec :: Int -> ConditionValue -> ShowS # show :: ConditionValue -> String # showList :: [ConditionValue] -> ShowS #
Eq ConditionValue Source #
Instance details Defined in IHP.QueryBuilder.Types Methods (==) :: ConditionValue -> ConditionValue -> Bool # (/=) :: ConditionValue -> ConditionValue -> Bool #

data OrderByClause Source #

Represents an ORDER BY clause component

Constructors

OrderByClause
Fields orderByColumn :: !Text orderByDirection :: !OrderByDirection

Instances

Instances details

NFData OrderByClause Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

rnf :: OrderByClause -> () #

Generic OrderByClause Source #

Instance details

Defined in IHP.QueryBuilder.Types

Associated Types

type Rep OrderByClause

Instance details

Defined in IHP.QueryBuilder.Types

type Rep OrderByClause = D1 ('MetaData "OrderByClause" "IHP.QueryBuilder.Types" "ihp-1.5.0-JkJMY5grI1LEXDOsW6DsRv" 'False) (C1 ('MetaCons "OrderByClause" 'PrefixI 'True) (S1 ('MetaSel ('Just "orderByColumn") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "orderByDirection") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OrderByDirection)))

Methods

from :: OrderByClause -> Rep OrderByClause x #

to :: Rep OrderByClause x -> OrderByClause #

Show OrderByClause Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

showsPrec :: Int -> OrderByClause -> ShowS #

show :: OrderByClause -> String #

showList :: [OrderByClause] -> ShowS #

Eq OrderByClause Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

(==) :: OrderByClause -> OrderByClause -> Bool #

(/=) :: OrderByClause -> OrderByClause -> Bool #

SetField "orderByClause" SQLQuery [OrderByClause] Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

setField :: [OrderByClause] -> SQLQuery -> SQLQuery Source #

type Rep OrderByClause Source #

Instance details

Defined in IHP.QueryBuilder.Types

type Rep OrderByClause = D1 ('MetaData "OrderByClause" "IHP.QueryBuilder.Types" "ihp-1.5.0-JkJMY5grI1LEXDOsW6DsRv" 'False) (C1 ('MetaCons "OrderByClause" 'PrefixI 'True) (S1 ('MetaSel ('Just "orderByColumn") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "orderByDirection") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OrderByDirection)))

data OrderByDirection Source #

ORDER BY direction

Constructors

Asc
Desc

Instances

Instances details

NFData OrderByDirection Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

rnf :: OrderByDirection -> () #

Generic OrderByDirection Source #

Instance details

Defined in IHP.QueryBuilder.Types

Associated Types

type Rep OrderByDirection
Instance details Defined in IHP.QueryBuilder.Types type Rep OrderByDirection = D1 ('MetaData "OrderByDirection" "IHP.QueryBuilder.Types" "ihp-1.5.0-JkJMY5grI1LEXDOsW6DsRv" 'False) (C1 ('MetaCons "Asc" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Desc" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: OrderByDirection -> Rep OrderByDirection x #

to :: Rep OrderByDirection x -> OrderByDirection #

Show OrderByDirection Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

showsPrec :: Int -> OrderByDirection -> ShowS #

show :: OrderByDirection -> String #

showList :: [OrderByDirection] -> ShowS #

Eq OrderByDirection Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

(==) :: OrderByDirection -> OrderByDirection -> Bool #

(/=) :: OrderByDirection -> OrderByDirection -> Bool #

type Rep OrderByDirection Source #

Instance details

Defined in IHP.QueryBuilder.Types

type Rep OrderByDirection = D1 ('MetaData "OrderByDirection" "IHP.QueryBuilder.Types" "ihp-1.5.0-JkJMY5grI1LEXDOsW6DsRv" 'False) (C1 ('MetaCons "Asc" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Desc" 'PrefixI 'False) (U1 :: Type -> Type))

data FilterOperator Source #

Operators used in WHERE clause conditions

Constructors

EqOp	col = val
NotEqOp	col != val
InOp	col IN (set)
NotInOp	col NOT IN (set)
IsOp	col IS val
IsNotOp	col IS NOT val
LikeOp !MatchSensitivity	col LIKE val
NotLikeOp !MatchSensitivity	col NOT LIKE val
MatchesOp !MatchSensitivity	col ~ pattern
GreaterThanOp	col > val
GreaterThanOrEqualToOp	col >= val
LessThanOp	col < val
LessThanOrEqualToOp	col <= val
SqlOp	Used by `filterWhereSql`

Instances

Instances details

Show FilterOperator Source #
Instance details Defined in IHP.QueryBuilder.Types Methods showsPrec :: Int -> FilterOperator -> ShowS # show :: FilterOperator -> String # showList :: [FilterOperator] -> ShowS #
Eq FilterOperator Source #
Instance details Defined in IHP.QueryBuilder.Types Methods (==) :: FilterOperator -> FilterOperator -> Bool # (/=) :: FilterOperator -> FilterOperator -> Bool #

data MatchSensitivity Source #

Represents whether string matching should be case-sensitive or not

Constructors

CaseSensitive
CaseInsensitive

Instances

Instances details

Show MatchSensitivity Source #
Instance details Defined in IHP.QueryBuilder.Types Methods showsPrec :: Int -> MatchSensitivity -> ShowS # show :: MatchSensitivity -> String # showList :: [MatchSensitivity] -> ShowS #
Eq MatchSensitivity Source #
Instance details Defined in IHP.QueryBuilder.Types Methods (==) :: MatchSensitivity -> MatchSensitivity -> Bool # (/=) :: MatchSensitivity -> MatchSensitivity -> Bool #

Helpers

addCondition :: forall (table :: Symbol). Condition -> QueryBuilder table -> QueryBuilder table Source #

Add a WHERE condition to a QueryBuilder, ANDing with any existing condition.

qualifyAndJoinColumns :: Text -> [Text] -> Text Source #

Pre-compute the qualified, comma-separated column selector. E.g. qualifyAndJoinColumns "users" ["id", "name"] = "users.id, users.name"

Intentionally NOINLINE: call sites (query, def) are lifted to CAFs, so this is evaluated once per table type. NOINLINE prevents GHC from inlining the map/intercalate into every use site of the resulting SQLQuery.

Type Classes

class DefaultScope (table :: Symbol) where Source #

Type class for default scoping of queries

Methods

defaultScope :: QueryBuilder table -> QueryBuilder table Source #

Instances

Instances details

DefaultScope table Source #
Instance details Defined in IHP.QueryBuilder.Types Methods defaultScope :: QueryBuilder table -> QueryBuilder table Source #

class EqOrIsOperator value where Source #

Helper to deal with some_field IS NULL and some_field = 'some value'

Methods

toEqOrIsOperator :: value -> FilterOperator Source #

Instances

Instances details

EqOrIsOperator otherwise Source #
Instance details Defined in IHP.QueryBuilder.Types Methods toEqOrIsOperator :: otherwise -> FilterOperator Source #
EqOrIsOperator (Maybe something) Source #
Instance details Defined in IHP.QueryBuilder.Types Methods toEqOrIsOperator :: Maybe something -> FilterOperator Source #

class FilterPrimaryKey (table :: Symbol) where Source #

Type class for filtering by primary key

Methods

filterWhereId :: Id' table -> QueryBuilder table -> QueryBuilder table Source #