Data.ApiDataTypes

This provides types that represent sql query structure

Documentation

data TableName

Type declaration

Represents db table name

Constructors

TableName Text

Instances

Show TableName

Methods

showsPrec :: Int -> TableName -> ShowS

show :: TableName -> String

showList :: [TableName] -> ShowS

Generic TableName

Associated Types

type Rep TableName :: * -> *

Methods

from :: TableName -> Rep TableName x

to :: Rep TableName x -> TableName

ToJSON TableName

Json instance for TableName

Methods

toJSON :: TableName -> Value

toEncoding :: TableName -> Encoding

toJSONList :: [TableName] -> Value

toEncodingList :: [TableName] -> Encoding

FromJSON TableName

Instances

Json instance for TableName

Methods

parseJSON :: Value -> Parser TableName

parseJSONList :: Value -> Parser [TableName]

type Rep TableName

type Rep TableName = D1 (MetaData "TableName" "Data.ApiDataTypes" "serviette-0.1.0.3-ColhqKU6zzNJ1eAjDDgKa7" False) (C1 (MetaCons "TableName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data ColumnName

Represents db table column name

Constructors

ColumnName Text

Instances

Show ColumnName

Methods

showsPrec :: Int -> ColumnName -> ShowS

show :: ColumnName -> String

showList :: [ColumnName] -> ShowS

Generic ColumnName

Associated Types

type Rep ColumnName :: * -> *

Methods

from :: ColumnName -> Rep ColumnName x

to :: Rep ColumnName x -> ColumnName

ToJSON ColumnName

aeson instance for ColumnName

Methods

toJSON :: ColumnName -> Value

toEncoding :: ColumnName -> Encoding

toJSONList :: [ColumnName] -> Value

toEncodingList :: [ColumnName] -> Encoding

FromJSON ColumnName

aeson instance for ColumnName

Methods

parseJSON :: Value -> Parser ColumnName

parseJSONList :: Value -> Parser [ColumnName]

type Rep ColumnName

type Rep ColumnName = D1 (MetaData "ColumnName" "Data.ApiDataTypes" "serviette-0.1.0.3-ColhqKU6zzNJ1eAjDDgKa7" False) (C1 (MetaCons "ColumnName" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data Operator

Represents operator (=, >, <, like, not like etc.)

Constructors

Operator Text

Instances

Show Operator

Methods

showsPrec :: Int -> Operator -> ShowS

show :: Operator -> String

showList :: [Operator] -> ShowS

Generic Operator

Associated Types

type Rep Operator :: * -> *

Methods

from :: Operator -> Rep Operator x

to :: Rep Operator x -> Operator

ToJSON Operator

aeson instance for Operator

Methods

toJSON :: Operator -> Value

toEncoding :: Operator -> Encoding

toJSONList :: [Operator] -> Value

toEncodingList :: [Operator] -> Encoding

FromJSON Operator

aeson instance for Operator

Methods

parseJSON :: Value -> Parser Operator

parseJSONList :: Value -> Parser [Operator]

type Rep Operator

type Rep Operator = D1 (MetaData "Operator" "Data.ApiDataTypes" "serviette-0.1.0.3-ColhqKU6zzNJ1eAjDDgKa7" False) (C1 (MetaCons "Operator" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data Action

Represents the main action for the sql query (SELECT,INSERT, UPDATE, DELETE)

Constructors

Action Text

Instances

Show Action

Methods

showsPrec :: Int -> Action -> ShowS

show :: Action -> String

showList :: [Action] -> ShowS

Generic Action

Associated Types

type Rep Action :: * -> *

Methods

from :: Action -> Rep Action x

to :: Rep Action x -> Action

ToJSON Action

aeson instance for Action

Methods

toJSON :: Action -> Value

toEncoding :: Action -> Encoding

toJSONList :: [Action] -> Value

toEncodingList :: [Action] -> Encoding

FromJSON Action

aeson instance for Action

Methods

parseJSON :: Value -> Parser Action

parseJSONList :: Value -> Parser [Action]

type Rep Action

type Rep Action = D1 (MetaData "Action" "Data.ApiDataTypes" "serviette-0.1.0.3-ColhqKU6zzNJ1eAjDDgKa7" False) (C1 (MetaCons "Action" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data Format

Represents return format (for now this is only raw sql string)

Constructors

Format

Fields

• getFormat :: Int

Instances

Eq Format

Methods

(==) :: Format -> Format -> Bool

(/=) :: Format -> Format -> Bool

Show Format

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

type DateVal = Text

Represents Date field value

data FieldValue

Represents field value which can be integer, string or date

Constructors

IntField Int

TextField Text

DateField DateVal

Instances

Show FieldValue

Methods

showsPrec :: Int -> FieldValue -> ShowS

show :: FieldValue -> String

showList :: [FieldValue] -> ShowS

Generic FieldValue

Associated Types

type Rep FieldValue :: * -> *

Methods

from :: FieldValue -> Rep FieldValue x

to :: Rep FieldValue x -> FieldValue

ToJSON FieldValue

aeson instance for FieldValue

Methods

toJSON :: FieldValue -> Value

toEncoding :: FieldValue -> Encoding

toJSONList :: [FieldValue] -> Value

toEncodingList :: [FieldValue] -> Encoding

FromJSON FieldValue

aeson instance for FieldValue

Methods

parseJSON :: Value -> Parser FieldValue

parseJSONList :: Value -> Parser [FieldValue]

type Rep FieldValue

type Rep FieldValue = D1 (MetaData "FieldValue" "Data.ApiDataTypes" "serviette-0.1.0.3-ColhqKU6zzNJ1eAjDDgKa7" False) ((:+:) (C1 (MetaCons "IntField" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))) ((:+:) (C1 (MetaCons "TextField" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) (C1 (MetaCons "DateField" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DateVal)))))

data JoinTable

Represents join table for the sql query

Constructors

JoinTable

Fields

• tablename :: TableName
• field :: ColumnName
• operator :: Operator
• withTable :: TableName
• withField :: ColumnName

Instances

Show JoinTable

Methods

showsPrec :: Int -> JoinTable -> ShowS

show :: JoinTable -> String

showList :: [JoinTable] -> ShowS

Generic JoinTable

Associated Types

type Rep JoinTable :: * -> *

Methods

from :: JoinTable -> Rep JoinTable x

to :: Rep JoinTable x -> JoinTable

ToJSON JoinTable

aeson instance for JoinTable

Methods

toJSON :: JoinTable -> Value

toEncoding :: JoinTable -> Encoding

toJSONList :: [JoinTable] -> Value

toEncodingList :: [JoinTable] -> Encoding

FromJSON JoinTable

aeson instance for JoinTable

Methods

parseJSON :: Value -> Parser JoinTable

parseJSONList :: Value -> Parser [JoinTable]

type Rep JoinTable

type Rep JoinTable = D1 (MetaData "JoinTable" "Data.ApiDataTypes" "serviette-0.1.0.3-ColhqKU6zzNJ1eAjDDgKa7" False) (C1 (MetaCons "JoinTable" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "tablename") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TableName)) (S1 (MetaSel (Just Symbol "field") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ColumnName))) ((:*:) (S1 (MetaSel (Just Symbol "operator") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Operator)) ((:*:) (S1 (MetaSel (Just Symbol "withTable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TableName)) (S1 (MetaSel (Just Symbol "withField") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ColumnName))))))

data WhereCondition

Represents main where condition

Constructors

WhereCondition

Fields

• whereTableName :: TableName
• whereField :: ColumnName
• whereOperator :: Operator
• whereFieldValue :: FieldValue

Instances

Show WhereCondition

Methods

showsPrec :: Int -> WhereCondition -> ShowS

show :: WhereCondition -> String

showList :: [WhereCondition] -> ShowS

Generic WhereCondition

Associated Types

type Rep WhereCondition :: * -> *

Methods

from :: WhereCondition -> Rep WhereCondition x

to :: Rep WhereCondition x -> WhereCondition

ToJSON WhereCondition

aeson instance for WhereCondition

Methods

toJSON :: WhereCondition -> Value

toEncoding :: WhereCondition -> Encoding

toJSONList :: [WhereCondition] -> Value

toEncodingList :: [WhereCondition] -> Encoding

FromJSON WhereCondition

aeson instance for WhereCondition

Methods

parseJSON :: Value -> Parser WhereCondition

parseJSONList :: Value -> Parser [WhereCondition]

type Rep WhereCondition

type Rep WhereCondition = D1 (MetaData "WhereCondition" "Data.ApiDataTypes" "serviette-0.1.0.3-ColhqKU6zzNJ1eAjDDgKa7" False) (C1 (MetaCons "WhereCondition" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "whereTableName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TableName)) (S1 (MetaSel (Just Symbol "whereField") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ColumnName))) ((:*:) (S1 (MetaSel (Just Symbol "whereOperator") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Operator)) (S1 (MetaSel (Just Symbol "whereFieldValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FieldValue)))))

data SqlQuery

Represents intermediate type for receiving json

Constructors

SqlQuery

Fields

• format :: Int
• action :: Action
• selectName :: TableName
• joinTables :: [JoinTable]
• whereCondition :: [WhereCondition]

Instances

Show SqlQuery

Methods

showsPrec :: Int -> SqlQuery -> ShowS

show :: SqlQuery -> String

showList :: [SqlQuery] -> ShowS

Generic SqlQuery

Associated Types

type Rep SqlQuery :: * -> *

Methods

from :: SqlQuery -> Rep SqlQuery x

to :: Rep SqlQuery x -> SqlQuery

ToJSON SqlQuery

aeson instance for SqlQuery

Methods

toJSON :: SqlQuery -> Value

toEncoding :: SqlQuery -> Encoding

toJSONList :: [SqlQuery] -> Value

toEncodingList :: [SqlQuery] -> Encoding

FromJSON SqlQuery

aeson instance for SqlQuery

Methods

parseJSON :: Value -> Parser SqlQuery

parseJSONList :: Value -> Parser [SqlQuery]

type Rep SqlQuery

type Rep SqlQuery = D1 (MetaData "SqlQuery" "Data.ApiDataTypes" "serviette-0.1.0.3-ColhqKU6zzNJ1eAjDDgKa7" False) (C1 (MetaCons "SqlQuery" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "format") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) (S1 (MetaSel (Just Symbol "action") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Action))) ((:*:) (S1 (MetaSel (Just Symbol "selectName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TableName)) ((:*:) (S1 (MetaSel (Just Symbol "joinTables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [JoinTable])) (S1 (MetaSel (Just Symbol "whereCondition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [WhereCondition]))))))

data SqlResultQuery

Represents type that is the result of the json "computation"

Constructors

SqlResultQuery

Fields

• getAction :: Action
• getSelectTable :: TableName
• getJoins :: [JoinTable]
• getWhereCondition :: [WhereCondition]

Instances

Show SqlResultQuery

Methods

showsPrec :: Int -> SqlResultQuery -> ShowS

show :: SqlResultQuery -> String

showList :: [SqlResultQuery] -> ShowS

Generic SqlResultQuery

Associated Types

type Rep SqlResultQuery :: * -> *

Methods

from :: SqlResultQuery -> Rep SqlResultQuery x

to :: Rep SqlResultQuery x -> SqlResultQuery

ToJSON SqlResultQuery

aeson instance for SqlResultQuery

Methods

toJSON :: SqlResultQuery -> Value

toEncoding :: SqlResultQuery -> Encoding

toJSONList :: [SqlResultQuery] -> Value

toEncodingList :: [SqlResultQuery] -> Encoding

FromJSON SqlResultQuery

aeson instance for SqlResultQuery

Methods

parseJSON :: Value -> Parser SqlResultQuery

parseJSONList :: Value -> Parser [SqlResultQuery]

type Rep SqlResultQuery

type Rep SqlResultQuery = D1 (MetaData "SqlResultQuery" "Data.ApiDataTypes" "serviette-0.1.0.3-ColhqKU6zzNJ1eAjDDgKa7" False) (C1 (MetaCons "SqlResultQuery" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "getAction") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Action)) (S1 (MetaSel (Just Symbol "getSelectTable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TableName))) ((:*:) (S1 (MetaSel (Just Symbol "getJoins") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [JoinTable])) (S1 (MetaSel (Just Symbol "getWhereCondition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [WhereCondition])))))