Contents Index

Framework.ORM.Types

Contents SQL query ADT Data model ADT

Synopsis

data Tables = TableList [SQLTable] | TableJoin [SQLTable] data Query = Query { qFields :: [SQLField] qTables :: Tables qWhere :: SQLCondition qOrder :: [SQLOrder] qGroup :: [String] qLimits :: Maybe (Int, Int) } | InsertQuery { iTable :: String iFields :: [String] iValues :: [String] } | UpdateQuery { uTable :: String uFields :: [String] uValues :: [String] uWhere :: SQLCondition } | DelQuery { dTable :: String dWhere :: SQLCondition } data SQLField = QField String | QFn String String type SQLTable = String data SQLCondition = NoCondition | forall a b . (Parameter a, Parameter b) => a :==: b | forall a b . (Parameter a, Parameter b) => a :/=: b | forall a b . (Parameter a, Parameter b) => a :>: b | forall a b . (Parameter a, Parameter b) => a :<: b | SQLCondition :&: SQLCondition | SQLCondition :|: SQLCondition class Parameter a where asString :: a -> String asValue :: a -> Maybe SqlValue type Selector = forall a. Parameter a => a data SQLOrder = Asceding String | Desceding String class SQLFragment s where sqlFragment :: s -> String sqlFPair :: SQLFragment f => String -> f -> f -> String sqlLift :: (Parameter a, Parameter a1) => String -> a -> a1 -> String data ColumnType = IntegerColumn | PrimaryKey | ForeignKey Model String | StringColumn | BoolColumn | CurrentDateColumn data Model = Model { mName :: String mTable :: String mFields :: [ModelField] mCached :: [ModelField] related :: [(String, [Model])] defaultOrdering :: [SQLOrder] perPage :: Maybe Int showMe :: Model -> String } data ModelField = String ::: ColumnType | FilledField String ColumnType SqlValue | ValidateBy ModelField FieldValidator | forall w . Widget w => UsingWidget ModelField w mfName :: ModelField -> String mfType :: ModelField -> ColumnType

SQL query ADT

data Tables

List of tables: simple list or Join Constructors TableList [SQLTable] TableJoin [SQLTable] Instances Eq Tables Show Tables

data Query

ADT for SQL Query Constructors Query qFields :: [SQLField] Fields to select qTables :: Tables qWhere :: SQLCondition Conditions (WHERE part) qOrder :: [SQLOrder] ORDER BY part qGroup :: [String] GROUP BY part qLimits :: Maybe (Int, Int) OFFSET ... LIMIT part InsertQuery iTable :: String Table iFields :: [String] Fields list iValues :: [String] Values UpdateQuery uTable :: String Table uFields :: [String] Fields uValues :: [String] Values uWhere :: SQLCondition Condition (WHERE part) DelQuery dTable :: String dWhere :: SQLCondition

data SQLField

Constructors QField String Just a named field QFn String String Some function of field, e.g. count(id) Instances Eq SQLField Show SQLField SQLFragment SQLField

type SQLTable = String

data SQLCondition

ADT for SQL conditions Constructors NoCondition forall a b . (Parameter a, Parameter b) => a :==: b forall a b . (Parameter a, Parameter b) => a :/=: b forall a b . (Parameter a, Parameter b) => a :>: b forall a b . (Parameter a, Parameter b) => a :<: b SQLCondition :&: SQLCondition SQLCondition :|: SQLCondition Instances Eq SQLCondition SQLFragment SQLCondition

class Parameter a where

Methods asString :: a -> String asValue :: a -> Maybe SqlValue Instances Parameter String Parameter SqlValue

type Selector = forall a. Parameter a => a

data SQLOrder

Constructors Asceding String Desceding String Instances Eq SQLOrder Show SQLOrder SQLFragment SQLOrder

class SQLFragment s where

Methods sqlFragment :: s -> String Instances SQLFragment SQLOrder SQLFragment SQLCondition SQLFragment SQLField

sqlFPair :: SQLFragment f => String -> f -> f -> String

sqlLift :: (Parameter a, Parameter a1) => String -> a -> a1 -> String

Data model ADT

data ColumnType

Type of DB table column Constructors IntegerColumn PrimaryKey ForeignKey Model String Foreign key parent model> <link field in parent model StringColumn BoolColumn CurrentDateColumn Instances Eq ColumnType Show ColumnType

data Model

DB model (table) itself Constructors Model mName :: String Model name mTable :: String DB table name mFields :: [ModelField] List of model fields (DB table columns) mCached :: [ModelField] Additional fields, which are no in DB related :: [(String, [Model])] Assoc.list of related (children) models defaultOrdering :: [SQLOrder] How to sort list of this models by default perPage :: Maybe Int Default paging showMe :: Model -> String Instances Eq Model Show Model TemplateOne Model

data ModelField

Field for Model Constructors String ::: ColumnType FilledField String ColumnType SqlValue ValidateBy ModelField FieldValidator forall w . Widget w => UsingWidget ModelField w Instances Show ModelField

mfName :: ModelField -> String

mfType :: ModelField -> ColumnType

Produced by Haddock version 2.4.2