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
- | TextValue Text
- | BoolValue Bool
- | UUIDValue UUID
- | DateTimeValue UTCTime
data DynamicSQLQuery = DynamicSQLQuery {
- table :: !Text
- selectedColumns :: SelectedColumns
- whereCondition :: !(Maybe Condition)
- orderByClause :: ![OrderByClause]
- limitClause :: !(Maybe Text)
- offsetClause :: !(Maybe Text)
}
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 #

data DynamicValue Source #

Constructors

IntValue Int
TextValue Text
BoolValue Bool
UUIDValue UUID
DateTimeValue UTCTime

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 Condition) orderByClause :: ![OrderByClause] limitClause :: !(Maybe Text) offsetClause :: !(Maybe Text)

Instances

Instances details

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

data SelectedColumns Source #

Constructors

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

Instances

Instances details

Eq SelectedColumns Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods (==) :: SelectedColumns -> SelectedColumns -> Bool # (/=) :: SelectedColumns -> SelectedColumns -> Bool #
Show SelectedColumns Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods showsPrec :: Int -> SelectedColumns -> ShowS # show :: SelectedColumns -> String showList :: [SelectedColumns] -> ShowS #
FromJSON SelectedColumns Source #
Instance details Defined in IHP.DataSync.DynamicQuery Methods parseJSON :: Value -> Parser SelectedColumns # parseJSONList :: Value -> Parser [SelectedColumns] #
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] #
FromJSON Action Source #
Instance details Methods parseJSON :: Value -> Parser Action # parseJSONList :: Value -> Parser [Action] #
FromJSON OrderByDirection Source #
Instance details Methods parseJSON :: Value -> Parser OrderByDirection # parseJSONList :: Value -> Parser [OrderByDirection] #
FromJSON Join Source #
Instance details Methods parseJSON :: Value -> Parser Join # parseJSONList :: Value -> Parser [Join] #
FromJSON Condition Source #
Instance details Methods parseJSON :: Value -> Parser Condition # parseJSONList :: Value -> Parser [Condition] #
FromJSON OrderByClause Source #
Instance details Methods parseJSON :: Value -> Parser OrderByClause # parseJSONList :: Value -> Parser [OrderByClause] #