Copyright	(c) digitally induced GmbH 2021
Safe Haskell	None

IHP.DataSync.DynamicQuery

Contents

Orphan instances

Description

Synopsis

data Field = Field {
- fieldName :: Text
- fieldValue :: DynamicValue
}
data DynamicValue
- = IntValue !Int
- | DoubleValue !Double
- | TextValue !Text
- | BoolValue !Bool
- | UUIDValue !UUID
- | DateTimeValue !UTCTime
- | PointValue !Point
- | IntervalValue !PGInterval
- | ArrayValue ![DynamicValue]
- | Null
newtype UndecodedJSON = UndecodedJSON ByteString
data DynamicSQLQuery = DynamicSQLQuery {
- table :: !Text
- selectedColumns :: SelectedColumns
- whereCondition :: !(Maybe ConditionExpression)
- orderByClause :: ![OrderByClause]
- distinctOnColumn :: !(Maybe ByteString)
- limit :: !(Maybe Int)
- offset :: !(Maybe Int)
}
data OrderByClause
- = OrderByClause {
  - orderByColumn :: !ByteString
  - orderByDirection :: !OrderByDirection
  }
- | OrderByTSRank {
  - tsvector :: Text
  - tsquery :: !Text
  }
data ConditionExpression
- = ColumnExpression {
  - field :: !Text
  }
- | InfixOperatorExpression {
  - left :: !ConditionExpression
  - op :: !ConditionOperator
  - right :: !ConditionExpression
  }
- | LiteralExpression {
  - value :: !DynamicValue
  }
- | CallExpression {
  - functionCall :: !FunctionCall
  }
- | ListExpression {
  - values :: ![DynamicValue]
  }
data FunctionCall = ToTSQuery {
- text :: !Text
}
data ConditionOperator
- = OpEqual
- | OpGreaterThan
- | OpLessThan
- | OpGreaterThanOrEqual
- | OpLessThanOrEqual
- | OpNotEqual
- | OpAnd
- | OpOr
- | OpIs
- | OpIsNot
- | OpTSMatch
- | OpIn
data SelectedColumns
- = SelectAll
- | SelectSpecific [Text]
recordIds :: [[Field]] -> [UUID]
transformColumnNamesToFieldNames :: Value -> Value

Documentation

data Field Source #

Constructors

Field
Fields fieldName :: Text fieldValue :: DynamicValue

Instances

Instances details

FromField Field Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods fromField :: FieldParser Field
ToJSON [Field] Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods toJSON :: [Field] -> Value # toEncoding :: [Field] -> Encoding # toJSONList :: [[Field]] -> Value # toEncodingList :: [[Field]] -> Encoding # omitField :: [Field] -> Bool #

data DynamicValue Source #

Constructors

IntValue !Int
DoubleValue !Double
TextValue !Text
BoolValue !Bool
UUIDValue !UUID
DateTimeValue !UTCTime
PointValue !Point
IntervalValue !PGInterval
ArrayValue ![DynamicValue]
Null

Instances

Instances details

FromJSON DynamicValue Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods parseJSON :: Value -> Parser DynamicValue # parseJSONList :: Value -> Parser [DynamicValue] # omittedField :: Maybe DynamicValue #
ToJSON DynamicValue Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods toJSON :: DynamicValue -> Value # toEncoding :: DynamicValue -> Encoding # toJSONList :: [DynamicValue] -> Value # toEncodingList :: [DynamicValue] -> Encoding # omitField :: DynamicValue -> Bool #
Show DynamicValue Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods showsPrec :: Int -> DynamicValue -> ShowS # show :: DynamicValue -> String showList :: [DynamicValue] -> ShowS #
Eq DynamicValue Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods (==) :: DynamicValue -> DynamicValue -> Bool # (/=) :: DynamicValue -> DynamicValue -> Bool #
FromField DynamicValue Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods fromField :: FieldParser DynamicValue
ToField DynamicValue
Instance details Defined in IHP.DataSync.DynamicQueryCompiler Methods toField :: DynamicValue -> Action

newtype UndecodedJSON Source #

Constructors

UndecodedJSON ByteString

Instances

Instances details

ToJSON UndecodedJSON Source #
Instance details Defined in IHP.DataSync.REST.Controller Methods toJSON :: UndecodedJSON -> Value # toEncoding :: UndecodedJSON -> Encoding # toJSONList :: [UndecodedJSON] -> Value # toEncodingList :: [UndecodedJSON] -> Encoding # omitField :: UndecodedJSON -> Bool #
Show UndecodedJSON Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods showsPrec :: Int -> UndecodedJSON -> ShowS # show :: UndecodedJSON -> String showList :: [UndecodedJSON] -> ShowS #
Eq UndecodedJSON Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods (==) :: UndecodedJSON -> UndecodedJSON -> Bool # (/=) :: UndecodedJSON -> UndecodedJSON -> Bool #
FromField UndecodedJSON Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods fromField :: FieldParser UndecodedJSON

data DynamicSQLQuery Source #

Similiar to IHP.QueryBuilder.SQLQuery, but is designed to be accessed by external users

When compiling to SQL we have to be extra careful to escape all identifers and variables in the query. The normal IHP.QueryBuilder doesn't need to be that careful as parts of the input are derived from generated code from the Schema.sql.

Constructors

DynamicSQLQuery
Fields table :: !Text selectedColumns :: SelectedColumns whereCondition :: !(Maybe ConditionExpression) orderByClause :: ![OrderByClause] distinctOnColumn :: !(Maybe ByteString) limit :: !(Maybe Int) offset :: !(Maybe Int)

Instances

Instances details

FromJSON DynamicSQLQuery Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods parseJSON :: Value -> Parser DynamicSQLQuery # parseJSONList :: Value -> Parser [DynamicSQLQuery] # omittedField :: Maybe DynamicSQLQuery #
Show DynamicSQLQuery Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods showsPrec :: Int -> DynamicSQLQuery -> ShowS # show :: DynamicSQLQuery -> String showList :: [DynamicSQLQuery] -> ShowS #
Eq DynamicSQLQuery Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods (==) :: DynamicSQLQuery -> DynamicSQLQuery -> Bool # (/=) :: DynamicSQLQuery -> DynamicSQLQuery -> Bool #

data OrderByClause Source #

Constructors

OrderByClause
Fields orderByColumn :: !ByteString orderByDirection :: !OrderByDirection
OrderByTSRank
Fields tsvector :: Text tsquery :: !Text

Instances

Instances details

FromJSON OrderByClause Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Methods

parseJSON :: Value -> Parser OrderByClause #

parseJSONList :: Value -> Parser [OrderByClause] #

omittedField :: Maybe OrderByClause #

Generic OrderByClause Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Associated Types

type Rep OrderByClause

Instance details

Defined in IHP.DataSync.DynamicQuery

type Rep OrderByClause = D1 ('MetaData "OrderByClause" "IHP.DataSync.DynamicQuery" "main" 'False) (C1 ('MetaCons "OrderByClause" 'PrefixI 'True) (S1 ('MetaSel ('Just "orderByColumn") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "orderByDirection") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OrderByDirection)) :+: C1 ('MetaCons "OrderByTSRank" 'PrefixI 'True) (S1 ('MetaSel ('Just "tsvector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tsquery") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))

Methods

from :: OrderByClause -> Rep OrderByClause x

to :: Rep OrderByClause x -> OrderByClause

Show OrderByClause Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Methods

showsPrec :: Int -> OrderByClause -> ShowS #

show :: OrderByClause -> String

showList :: [OrderByClause] -> ShowS #

NFData OrderByClause Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Methods

rnf :: OrderByClause -> () #

Eq OrderByClause Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Methods

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

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

ParamReader OrderByClause Source #

Instance details

Defined in IHP.DataSync.REST.Controller

Methods

readParameter :: ByteString -> Either ByteString OrderByClause Source #

readParameterJSON :: Value -> Either ByteString OrderByClause Source #

type Rep OrderByClause Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

type Rep OrderByClause = D1 ('MetaData "OrderByClause" "IHP.DataSync.DynamicQuery" "main" 'False) (C1 ('MetaCons "OrderByClause" 'PrefixI 'True) (S1 ('MetaSel ('Just "orderByColumn") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "orderByDirection") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 OrderByDirection)) :+: C1 ('MetaCons "OrderByTSRank" 'PrefixI 'True) (S1 ('MetaSel ('Just "tsvector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tsquery") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))

data ConditionExpression Source #

Represents a WHERE conditions of a DynamicSQLQuery

Constructors

ColumnExpression
Fields field :: !Text
InfixOperatorExpression
Fields left :: !ConditionExpression op :: !ConditionOperator right :: !ConditionExpression
LiteralExpression
Fields value :: !DynamicValue
CallExpression
Fields functionCall :: !FunctionCall
ListExpression
Fields values :: ![DynamicValue]

Instances

Instances details

FromJSON ConditionExpression Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods parseJSON :: Value -> Parser ConditionExpression # parseJSONList :: Value -> Parser [ConditionExpression] # omittedField :: Maybe ConditionExpression #
Show ConditionExpression Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods showsPrec :: Int -> ConditionExpression -> ShowS # show :: ConditionExpression -> String showList :: [ConditionExpression] -> ShowS #
Eq ConditionExpression Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods (==) :: ConditionExpression -> ConditionExpression -> Bool # (/=) :: ConditionExpression -> ConditionExpression -> Bool #

data FunctionCall Source #

Constructors

ToTSQuery	to_tsquery(`english`, text)
Fields text :: !Text

Instances

Instances details

FromJSON FunctionCall Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Methods

parseJSON :: Value -> Parser FunctionCall #

parseJSONList :: Value -> Parser [FunctionCall] #

omittedField :: Maybe FunctionCall #

Generic FunctionCall Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Associated Types

type Rep FunctionCall
Instance details Defined in IHP.DataSync.DynamicQuery type Rep FunctionCall = D1 ('MetaData "FunctionCall" "IHP.DataSync.DynamicQuery" "main" 'False) (C1 ('MetaCons "ToTSQuery" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))

Methods

from :: FunctionCall -> Rep FunctionCall x

to :: Rep FunctionCall x -> FunctionCall

Show FunctionCall Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Methods

showsPrec :: Int -> FunctionCall -> ShowS #

show :: FunctionCall -> String

showList :: [FunctionCall] -> ShowS #

NFData FunctionCall Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Methods

rnf :: FunctionCall -> () #

Eq FunctionCall Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

Methods

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

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

type Rep FunctionCall Source #

Instance details

Defined in IHP.DataSync.DynamicQuery

type Rep FunctionCall = D1 ('MetaData "FunctionCall" "IHP.DataSync.DynamicQuery" "main" 'False) (C1 ('MetaCons "ToTSQuery" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)))

data ConditionOperator Source #

Operators available in WHERE conditions

Constructors

OpEqual	a = b
OpGreaterThan	a > b
OpLessThan	a < b
OpGreaterThanOrEqual	a >= b
OpLessThanOrEqual	a <= b
OpNotEqual	a <> b
OpAnd	a AND b
OpOr	a OR b
OpIs	a IS b
OpIsNot	a IS NOT b
OpTSMatch	tsvec_a @@ tsvec_b
OpIn	a IN b

Instances

Instances details

FromJSON ConditionOperator Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods parseJSON :: Value -> Parser ConditionOperator # parseJSONList :: Value -> Parser [ConditionOperator] # omittedField :: Maybe ConditionOperator #
Show ConditionOperator Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods showsPrec :: Int -> ConditionOperator -> ShowS # show :: ConditionOperator -> String showList :: [ConditionOperator] -> ShowS #
Eq ConditionOperator Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods (==) :: ConditionOperator -> ConditionOperator -> Bool # (/=) :: ConditionOperator -> ConditionOperator -> Bool #

data SelectedColumns Source #

Constructors

SelectAll	SELECT * FROM table
SelectSpecific [Text]	SELECT a, b, c FROM table

Instances

Instances details

FromJSON SelectedColumns Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods parseJSON :: Value -> Parser SelectedColumns # parseJSONList :: Value -> Parser [SelectedColumns] # omittedField :: Maybe SelectedColumns #
Show SelectedColumns Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods showsPrec :: Int -> SelectedColumns -> ShowS # show :: SelectedColumns -> String showList :: [SelectedColumns] -> ShowS #
Eq SelectedColumns Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods (==) :: SelectedColumns -> SelectedColumns -> Bool # (/=) :: SelectedColumns -> SelectedColumns -> Bool #
ParamReader SelectedColumns Source #
Instance details Defined in IHP.DataSync.REST.Controller Methods readParameter :: ByteString -> Either ByteString SelectedColumns Source # readParameterJSON :: Value -> Either ByteString SelectedColumns Source #

recordIds :: [[Field]] -> [UUID] Source #

Returns a list of all id's in a result

transformColumnNamesToFieldNames :: Value -> Value Source #

Transforms the keys of a JSON object from field name to column name

>>> transformColumnNamesToFieldNames [json|{"isCompleted": true}|]
[json|{"is_completed": true}|]

Orphan instances

FromJSON ByteString Source #
Instance details Methods parseJSON :: Value -> Parser ByteString # parseJSONList :: Value -> Parser [ByteString] # omittedField :: Maybe ByteString #
FromJSON Condition Source #
Instance details Methods parseJSON :: Value -> Parser Condition # parseJSONList :: Value -> Parser [Condition] # omittedField :: Maybe Condition #
FromJSON Join Source #
Instance details Methods parseJSON :: Value -> Parser Join # parseJSONList :: Value -> Parser [Join] # omittedField :: Maybe Join #
FromJSON OrderByClause Source #
Instance details Methods parseJSON :: Value -> Parser OrderByClause # parseJSONList :: Value -> Parser [OrderByClause] # omittedField :: Maybe OrderByClause #
FromJSON OrderByDirection Source #
Instance details Methods parseJSON :: Value -> Parser OrderByDirection # parseJSONList :: Value -> Parser [OrderByDirection] # omittedField :: Maybe OrderByDirection #
FromJSON Action Source #
Instance details Methods parseJSON :: Value -> Parser Action # parseJSONList :: Value -> Parser [Action] # omittedField :: Maybe Action #