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

IHP.QueryBuilder.Types

Contents

Core Types
Type-level Join Tracking
QueryBuilder Wrappers
Type Classes
Orphan instances

Description

Synopsis

data QueryBuilder (table :: Symbol)
- = NewQueryBuilder {
  - selectFrom :: !Text
  - columns :: ![Text]
  }
- | DistinctQueryBuilder {
  - queryBuilder :: !(QueryBuilder table)
  }
- | DistinctOnQueryBuilder {
  - queryBuilder :: !(QueryBuilder table)
  - distinctOnColumn :: !Text
  }
- | FilterByQueryBuilder {
  - queryBuilder :: !(QueryBuilder table)
  - queryFilter :: !(Text, FilterOperator, Snippet)
  - applyLeft :: !(Maybe Text)
  - applyRight :: !(Maybe Text)
  }
- | OrderByQueryBuilder {
  - queryBuilder :: !(QueryBuilder table)
  - queryOrderByClause :: !OrderByClause
  }
- | LimitQueryBuilder {
  - queryBuilder :: !(QueryBuilder table)
  - queryLimit :: !Int
  }
- | OffsetQueryBuilder {
  - queryBuilder :: !(QueryBuilder table)
  - queryOffset :: !Int
  }
- | UnionQueryBuilder {
  - firstQueryBuilder :: !(QueryBuilder table)
  - secondQueryBuilder :: !(QueryBuilder table)
  }
- | JoinQueryBuilder {
  - queryBuilder :: !(QueryBuilder table)
  - joinData :: Join
  }
data SQLQuery = SQLQuery {
- queryIndex :: !(Maybe Text)
- selectFrom :: !Text
- distinctClause :: !Bool
- distinctOnClause :: !(Maybe Text)
- whereCondition :: !(Maybe Condition)
- joins :: ![Join]
- orderByClause :: ![OrderByClause]
- limitClause :: !(Maybe Int)
- offsetClause :: !(Maybe Int)
- columns :: ![Text]
}
data Condition
- = ColumnCondition !Text !FilterOperator !Snippet !(Maybe Text) !(Maybe Text)
- | OrCondition !Condition !Condition
- | AndCondition !Condition !Condition
data Join = Join {
- table :: Text
- tableJoinColumn :: Text
- otherJoinColumn :: 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
data NoJoins
data EmptyModelList
data ConsModelList (model :: k) (models :: k1)
class ModelList (a :: k)
class IsJoined (a :: k) (b :: k1)
newtype JoinQueryBuilderWrapper (joinRegister :: k) (table :: Symbol) = JoinQueryBuilderWrapper (QueryBuilder table)
newtype NoJoinQueryBuilderWrapper (table :: Symbol) = NoJoinQueryBuilderWrapper (QueryBuilder table)
newtype LabeledQueryBuilderWrapper (foreignTable :: k) (indexColumn :: k1) (indexValue :: k2) (table :: Symbol) = LabeledQueryBuilderWrapper (QueryBuilder table)
class HasQueryBuilder (queryBuilderProvider :: Symbol -> Type) (joinRegister :: k) | queryBuilderProvider -> joinRegister where
- getQueryBuilder :: forall (table :: Symbol). queryBuilderProvider table -> QueryBuilder table
- injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> queryBuilderProvider table
- getQueryIndex :: forall (table :: Symbol). queryBuilderProvider table -> Maybe 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

data QueryBuilder (table :: Symbol) Source #

The main QueryBuilder data type, representing different query operations

Constructors

NewQueryBuilder
Fields selectFrom :: !Text columns :: ![Text]
DistinctQueryBuilder
Fields queryBuilder :: !(QueryBuilder table)
DistinctOnQueryBuilder
Fields queryBuilder :: !(QueryBuilder table) distinctOnColumn :: !Text
FilterByQueryBuilder
Fields queryBuilder :: !(QueryBuilder table) queryFilter :: !(Text, FilterOperator, Snippet) applyLeft :: !(Maybe Text) applyRight :: !(Maybe Text)
OrderByQueryBuilder
Fields queryBuilder :: !(QueryBuilder table) queryOrderByClause :: !OrderByClause
LimitQueryBuilder
Fields queryBuilder :: !(QueryBuilder table) queryLimit :: !Int
OffsetQueryBuilder
Fields queryBuilder :: !(QueryBuilder table) queryOffset :: !Int
UnionQueryBuilder
Fields firstQueryBuilder :: !(QueryBuilder table) secondQueryBuilder :: !(QueryBuilder table)
JoinQueryBuilder
Fields queryBuilder :: !(QueryBuilder table) joinData :: Join

Instances

Instances details

HasQueryBuilder QueryBuilder EmptyModelList Source #

QueryBuilders have query builders and the join register is empty.

Instance details

Defined in IHP.QueryBuilder.Types

Methods

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

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

getQueryIndex :: forall (table :: Symbol). QueryBuilder table -> Maybe Text Source #

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 -> Html

(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 queryIndex :: !(Maybe Text) selectFrom :: !Text distinctClause :: !Bool distinctOnClause :: !(Maybe Text) whereCondition :: !(Maybe Condition) joins :: ![Join] orderByClause :: ![OrderByClause] limitClause :: !(Maybe Int) offsetClause :: !(Maybe Int) columns :: ![Text]

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 "queryIndex" SQLQuery (Maybe Text) Source #
Instance details Defined in IHP.QueryBuilder.Types Methods setField :: Maybe Text -> 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 !Snippet !(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 Join Source #

Represents a JOIN clause

Constructors

Join
Fields table :: Text tableJoinColumn :: Text otherJoinColumn :: Text

Instances

Instances details

Show Join Source #
Instance details Defined in IHP.QueryBuilder.Types Methods showsPrec :: Int -> Join -> ShowS # show :: Join -> String # showList :: [Join] -> ShowS #
Eq Join Source #
Instance details Defined in IHP.QueryBuilder.Types Methods (==) :: Join -> Join -> Bool # (/=) :: Join -> Join -> 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.4.0-43TSTr8sXn3AQow4erFGsr" '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.4.0-43TSTr8sXn3AQow4erFGsr" '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.4.0-43TSTr8sXn3AQow4erFGsr" '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.4.0-43TSTr8sXn3AQow4erFGsr" '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 #

Type-level Join Tracking

data NoJoins Source #

Type-level marker indicating no joins are allowed

Instances

Instances details

HasQueryBuilder NoJoinQueryBuilderWrapper NoJoins Source #	NoJoinQueryBuilderWrapper have query builders and the join register does not allow any joins
Instance details Defined in IHP.QueryBuilder.Types Methods getQueryBuilder :: forall (table :: Symbol). NoJoinQueryBuilderWrapper table -> QueryBuilder table Source # injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> NoJoinQueryBuilderWrapper table Source # getQueryIndex :: forall (table :: Symbol). NoJoinQueryBuilderWrapper table -> Maybe Text Source #
(KnownSymbol foreignTable, foreignModel ~ GetModelByTableName foreignTable, KnownSymbol indexColumn, HasField indexColumn foreignModel indexValue) => HasQueryBuilder (LabeledQueryBuilderWrapper foreignTable indexColumn indexValue) NoJoins Source #
Instance details Defined in IHP.QueryBuilder.Types Methods getQueryBuilder :: forall (table :: Symbol). LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table -> QueryBuilder table Source # injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table Source # getQueryIndex :: forall (table :: Symbol). LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table -> Maybe Text Source #

data EmptyModelList Source #

Type-level empty list for tracking joined tables

Instances

Instances details

ModelList EmptyModelList Source #
Instance details Defined in IHP.QueryBuilder.Types
HasQueryBuilder QueryBuilder EmptyModelList Source #	QueryBuilders have query builders and the join register is empty.
Instance details Defined in IHP.QueryBuilder.Types Methods getQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> QueryBuilder table Source # injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> QueryBuilder table Source # getQueryIndex :: forall (table :: Symbol). QueryBuilder table -> Maybe Text Source #

data ConsModelList (model :: k) (models :: k1) Source #

Type-level cons cell for tracking joined tables

Instances

Instances details

ModelList b => IsJoined (a :: k2) (ConsModelList a b :: Type) Source #
Instance details Defined in IHP.QueryBuilder.Types
(ModelList b, IsJoined a b) => IsJoined (a :: k2) (ConsModelList c b :: Type) Source #
Instance details Defined in IHP.QueryBuilder.Types
ModelList (ConsModelList model models :: Type) Source #
Instance details Defined in IHP.QueryBuilder.Types

class ModelList (a :: k) Source #

Type class to represent the true list type EmptyModelList ConsModelList.

Instances

Instances details

ModelList EmptyModelList Source #
Instance details Defined in IHP.QueryBuilder.Types
ModelList (ConsModelList model models :: Type) Source #
Instance details Defined in IHP.QueryBuilder.Types

class IsJoined (a :: k) (b :: k1) Source #

Type class to query containment in the type-level list.

Instances

Instances details

ModelList b => IsJoined (a :: k2) (ConsModelList a b :: Type) Source #
Instance details Defined in IHP.QueryBuilder.Types
(ModelList b, IsJoined a b) => IsJoined (a :: k2) (ConsModelList c b :: Type) Source #
Instance details Defined in IHP.QueryBuilder.Types

QueryBuilder Wrappers

newtype JoinQueryBuilderWrapper (joinRegister :: k) (table :: Symbol) Source #

Wrapper for QueryBuilders resulting from joins. Associates a joinRegister type.

Constructors

JoinQueryBuilderWrapper (QueryBuilder table)

Instances

Instances details

HasQueryBuilder (JoinQueryBuilderWrapper joinRegister) (joinRegister :: k) Source #

JoinQueryBuilderWrappers have query builders

Instance details

Defined in IHP.QueryBuilder.Types

Methods

getQueryBuilder :: forall (table :: Symbol). JoinQueryBuilderWrapper joinRegister table -> QueryBuilder table Source #

injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> JoinQueryBuilderWrapper joinRegister table Source #

getQueryIndex :: forall (table :: Symbol). JoinQueryBuilderWrapper joinRegister table -> Maybe Text Source #

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

Instance details

Defined in IHP.Fetch

Associated Types

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

Methods

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

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

fetchOne :: JoinQueryBuilderWrapper r table -> IO model Source #

type FetchResult (JoinQueryBuilderWrapper r table) model Source #

Instance details

Defined in IHP.Fetch

type FetchResult (JoinQueryBuilderWrapper r table) model = [model]

newtype NoJoinQueryBuilderWrapper (table :: Symbol) Source #

Wrapper for QueryBuilder that must not joins, e.g. queryUnion.

Constructors

NoJoinQueryBuilderWrapper (QueryBuilder table)

Instances

Instances details

HasQueryBuilder NoJoinQueryBuilderWrapper NoJoins Source #

NoJoinQueryBuilderWrapper have query builders and the join register does not allow any joins

Instance details

Defined in IHP.QueryBuilder.Types

Methods

getQueryBuilder :: forall (table :: Symbol). NoJoinQueryBuilderWrapper table -> QueryBuilder table Source #

injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> NoJoinQueryBuilderWrapper table Source #

getQueryIndex :: forall (table :: Symbol). NoJoinQueryBuilderWrapper table -> Maybe Text Source #

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

Instance details

Defined in IHP.Fetch

Associated Types

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

Methods

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

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

fetchOne :: NoJoinQueryBuilderWrapper table -> IO model Source #

type FetchResult (NoJoinQueryBuilderWrapper table) model Source #

Instance details

Defined in IHP.Fetch

type FetchResult (NoJoinQueryBuilderWrapper table) model = [model]

newtype LabeledQueryBuilderWrapper (foreignTable :: k) (indexColumn :: k1) (indexValue :: k2) (table :: Symbol) Source #

Wrapper for QueryBuilders with indexed results.

Constructors

LabeledQueryBuilderWrapper (QueryBuilder table)

Instances

Instances details

(KnownSymbol foreignTable, foreignModel ~ GetModelByTableName foreignTable, KnownSymbol indexColumn, HasField indexColumn foreignModel indexValue) => HasQueryBuilder (LabeledQueryBuilderWrapper foreignTable indexColumn indexValue) NoJoins Source #

Instance details

Defined in IHP.QueryBuilder.Types

Methods

getQueryBuilder :: forall (table :: Symbol). LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table -> QueryBuilder table Source #

injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table Source #

getQueryIndex :: forall (table :: Symbol). LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table -> Maybe Text Source #

(model ~ GetModelByTableName table, KnownSymbol table, HasqlDecodeColumn value, KnownSymbol foreignTable, foreignModel ~ GetModelByTableName foreignTable, KnownSymbol columnName, HasField columnName foreignModel value, HasQueryBuilder (LabeledQueryBuilderWrapper foreignTable columnName value) NoJoins) => Fetchable (LabeledQueryBuilderWrapper foreignTable columnName value table) model Source #

Instance details

Defined in IHP.Fetch

Associated Types

type FetchResult (LabeledQueryBuilderWrapper foreignTable columnName value table) model
Instance details Defined in IHP.Fetch type FetchResult (LabeledQueryBuilderWrapper foreignTable columnName value table) model = [LabeledData value model]

Methods

fetch :: LabeledQueryBuilderWrapper foreignTable columnName value table -> IO (FetchResult (LabeledQueryBuilderWrapper foreignTable columnName value table) model) Source #

fetchOneOrNothing :: LabeledQueryBuilderWrapper foreignTable columnName value table -> IO (Maybe model) Source #

fetchOne :: LabeledQueryBuilderWrapper foreignTable columnName value table -> IO model Source #

type FetchResult (LabeledQueryBuilderWrapper foreignTable columnName value table) model Source #

Instance details

Defined in IHP.Fetch

type FetchResult (LabeledQueryBuilderWrapper foreignTable columnName value table) model = [LabeledData value model]

Type Classes

class HasQueryBuilder (queryBuilderProvider :: Symbol -> Type) (joinRegister :: k) | queryBuilderProvider -> joinRegister where Source #

Class to generalise over different QueryBuilder-providing types. The actual query builder can be extracted with getQueryBuilder and injected with injectQueryBuilder. Also assigns a join register to a queryBuilderProvider.

Minimal complete definition

getQueryBuilder, injectQueryBuilder

Methods

getQueryBuilder :: forall (table :: Symbol). queryBuilderProvider table -> QueryBuilder table Source #

injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> queryBuilderProvider table Source #

getQueryIndex :: forall (table :: Symbol). queryBuilderProvider table -> Maybe Text Source #

Instances

Instances details

HasQueryBuilder NoJoinQueryBuilderWrapper NoJoins Source #	NoJoinQueryBuilderWrapper have query builders and the join register does not allow any joins
Instance details Defined in IHP.QueryBuilder.Types Methods getQueryBuilder :: forall (table :: Symbol). NoJoinQueryBuilderWrapper table -> QueryBuilder table Source # injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> NoJoinQueryBuilderWrapper table Source # getQueryIndex :: forall (table :: Symbol). NoJoinQueryBuilderWrapper table -> Maybe Text Source #
HasQueryBuilder QueryBuilder EmptyModelList Source #	QueryBuilders have query builders and the join register is empty.
Instance details Defined in IHP.QueryBuilder.Types Methods getQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> QueryBuilder table Source # injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> QueryBuilder table Source # getQueryIndex :: forall (table :: Symbol). QueryBuilder table -> Maybe Text Source #
HasQueryBuilder (JoinQueryBuilderWrapper joinRegister) (joinRegister :: k) Source #	JoinQueryBuilderWrappers have query builders
Instance details Defined in IHP.QueryBuilder.Types Methods getQueryBuilder :: forall (table :: Symbol). JoinQueryBuilderWrapper joinRegister table -> QueryBuilder table Source # injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> JoinQueryBuilderWrapper joinRegister table Source # getQueryIndex :: forall (table :: Symbol). JoinQueryBuilderWrapper joinRegister table -> Maybe Text Source #
(KnownSymbol foreignTable, foreignModel ~ GetModelByTableName foreignTable, KnownSymbol indexColumn, HasField indexColumn foreignModel indexValue) => HasQueryBuilder (LabeledQueryBuilderWrapper foreignTable indexColumn indexValue) NoJoins Source #
Instance details Defined in IHP.QueryBuilder.Types Methods getQueryBuilder :: forall (table :: Symbol). LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table -> QueryBuilder table Source # injectQueryBuilder :: forall (table :: Symbol). QueryBuilder table -> LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table Source # getQueryIndex :: forall (table :: Symbol). LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table -> Maybe Text Source #

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 #

Orphan instances

Show Snippet Source #	Snippet doesn't have a Show instance, so we provide one for debugging QueryBuilder
Instance details Methods showsPrec :: Int -> Snippet -> ShowS # show :: Snippet -> String # showList :: [Snippet] -> ShowS #