Internal.Data.Basic.TH.Types

module Internal. : Data.Basic.TH.Types Description : Data types and utility function used during TH generation phase Copyright : (c) Nikola Henezi, 2016-2017 Luka Horvat, 2016-2017 License : MIT

This module Internal.defines data types that are used during parsing and TH generation stages. They describe structure of the parser and define minimal representation that is needed from parser in order to generate Template Haskell.

Documentation

data ParseError

When something goes wrong, this explains what went wrong - hopefully...

Constructors

ParseError Text

Instances

Show ParseError

Methods

showsPrec :: Int -> ParseError -> ShowS

show :: ParseError -> String

showList :: [ParseError] -> ShowS

Semigroup ParseError

Methods

(<>) :: ParseError -> ParseError -> ParseError

sconcat :: NonEmpty ParseError -> ParseError

stimes :: Integral b => b -> ParseError -> ParseError

Monoid ParseError

Methods

mempty :: ParseError

mappend :: ParseError -> ParseError -> ParseError

mconcat :: [ParseError] -> ParseError

data ColumnConstraint

List of constraints that can be applied to a Column and affect generated datatype Currently, only Null constraint affects it by wrapping data type with Maybe

Constructors

NullConstraint

NotNullConstraint

DefaultConstraint

Instances

Eq ColumnConstraint

Methods

(==) :: ColumnConstraint -> ColumnConstraint -> Bool

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

Show ColumnConstraint

Methods

showsPrec :: Int -> ColumnConstraint -> ShowS

show :: ColumnConstraint -> String

showList :: [ColumnConstraint] -> ShowS

data ColumnInfo

Column information gathered from a parser

Constructors

ColumnInfo

Fields

• _columnInfoText :: !Text

  name retrieved from the parser

• _columnInfoNormalName :: !Text

  normalized name of the field

• _columnInfoName :: !Name

  generate TH name

• _columnInfoType :: !Type

  generated TH type

• _columnInfoSqlType :: !TypeName

  original sql type

• _columnInfoConstraints :: ![ColumnConstraint]

  list of constraints that have to be applied

Instances

Eq ColumnInfo

Methods

(==) :: ColumnInfo -> ColumnInfo -> Bool

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

Show ColumnInfo

Methods

showsPrec :: Int -> ColumnInfo -> ShowS

show :: ColumnInfo -> String

showList :: [ColumnInfo] -> ShowS

columnInfoType :: Lens' ColumnInfo Type

columnInfoText :: Lens' ColumnInfo Text

columnInfoSqlType :: Lens' ColumnInfo TypeName

columnInfoNormalName :: Lens' ColumnInfo Text

columnInfoName :: Lens' ColumnInfo Name

columnInfoConstraints :: Lens' ColumnInfo [ColumnConstraint]

data EntityInfo

Entity information gathered from a parser

Constructors

EntityInfo

Fields

• _entityInfoText :: !Text

  name retrieved from the parser, basically a computed value of Name

• _entityInfoName :: !Name

  generated TH name

• _entityInfoSQLName :: !Name

  original sql name retrieved by hssqlpp

• _entityInfoType :: !Type

  generated datatype

• _entityInfoConstraintList :: ![Constraint]

  list of constraints that have to be applied

• _entityInfoColumnMap :: [ColumnInfo]

  list of all columns

Instances

Eq EntityInfo

Methods

(==) :: EntityInfo -> EntityInfo -> Bool

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

Show EntityInfo

Methods

showsPrec :: Int -> EntityInfo -> ShowS

show :: EntityInfo -> String

showList :: [EntityInfo] -> ShowS

entityInfoType :: Lens' EntityInfo Type

entityInfoText :: Lens' EntityInfo Text

entityInfoSQLName :: Lens' EntityInfo Name

entityInfoName :: Lens' EntityInfo Name

entityInfoConstraintList :: Lens' EntityInfo [Constraint]

entityInfoColumnMap :: Lens' EntityInfo [ColumnInfo]

data ForeignKeyConstraint

Minimal context we need to generate a foreign key constraint

Constructors

ForeignKeyConstraint

Fields

• _fkName :: !Text

  name of the foreign key

• _fkFromT :: !EntityInfo
• _fkFromCols :: ![ColumnInfo]
• _fkToT :: !EntityInfo

  referenced entity

• _fkToCols :: ![ColumnInfo]

  referenced columns

Instances

Show ForeignKeyConstraint

Methods

showsPrec :: Int -> ForeignKeyConstraint -> ShowS

show :: ForeignKeyConstraint -> String

showList :: [ForeignKeyConstraint] -> ShowS

fkToT :: Lens' ForeignKeyConstraint EntityInfo

fkToCols :: Lens' ForeignKeyConstraint [ColumnInfo]

fkName :: Lens' ForeignKeyConstraint Text

fkFromT :: Lens' ForeignKeyConstraint EntityInfo

fkFromCols :: Lens' ForeignKeyConstraint [ColumnInfo]

data UniqueKeyConstraint

Minimal context we need to generate a unique key constraint

Constructors

UniqueKeyConstraint

Fields

• _uqName :: !Text

  name of the constraint

• _uqEntity :: !EntityInfo

  referenced entity

• _uqCols :: ![ColumnInfo]

  referenced columns

Instances

Show UniqueKeyConstraint

Methods

showsPrec :: Int -> UniqueKeyConstraint -> ShowS

show :: UniqueKeyConstraint -> String

showList :: [UniqueKeyConstraint] -> ShowS

uqName :: Lens' UniqueKeyConstraint Text

uqEntity :: Lens' UniqueKeyConstraint EntityInfo

uqCols :: Lens' UniqueKeyConstraint [ColumnInfo]

data PrimaryKeyConstraint

Minimal context we need to generate a primary key constraint

Constructors

PrimaryKeyConstraint

Fields

• _pkName :: !Text

  name of the constraint

• _pkEntity :: !EntityInfo

  referenced entity

• _pkCols :: ![ColumnInfo]

  referenced columns

Instances

Show PrimaryKeyConstraint

Methods

showsPrec :: Int -> PrimaryKeyConstraint -> ShowS

show :: PrimaryKeyConstraint -> String

showList :: [PrimaryKeyConstraint] -> ShowS

pkName :: Lens' PrimaryKeyConstraint Text

pkEntity :: Lens' PrimaryKeyConstraint EntityInfo

pkCols :: Lens' PrimaryKeyConstraint [ColumnInfo]

data ParseContext

Full parse context. This datatype is filled with information as parser goes trough the sql file. After ParseContext is filled, TH takes over and code generation starts.

Constructors

ParseContext

Fields

• _entities :: ![EntityInfo]

  list of entities found

• _fks :: ![ForeignKeyConstraint]

  all foreign keys

• _pks :: ![PrimaryKeyConstraint]

  all primary keys

• _uqs :: ![UniqueKeyConstraint]

  all unique constraints

Instances

Show ParseContext

Methods

showsPrec :: Int -> ParseContext -> ShowS

show :: ParseContext -> String

showList :: [ParseContext] -> ShowS

Semigroup ParseContext

Methods

(<>) :: ParseContext -> ParseContext -> ParseContext

sconcat :: NonEmpty ParseContext -> ParseContext

stimes :: Integral b => b -> ParseContext -> ParseContext

Monoid ParseContext

Methods

mempty :: ParseContext

mappend :: ParseContext -> ParseContext -> ParseContext

mconcat :: [ParseContext] -> ParseContext

uqs :: Lens' ParseContext [UniqueKeyConstraint]

pks :: Lens' ParseContext [PrimaryKeyConstraint]

fks :: Lens' ParseContext [ForeignKeyConstraint]

entities :: Lens' ParseContext [EntityInfo]

class NullValue a where

Defines null values for all datatypes that we support in Basic. This is basically a hack to avoid usage of unsafeCoerce, because with unsafeCoerce you can hit segmentation faults due to wrong memory allocation (e.g. Int and Bool).

Minimal complete definition

nullValue

Methods

nullValue :: a

Instances

NullValue Bool

Methods

nullValue :: Bool

NullValue Double

Methods

nullValue :: Double

NullValue Int

Methods

nullValue :: Int

NullValue ByteString

Methods

nullValue :: ByteString

NullValue Scientific

Methods

nullValue :: Scientific

NullValue Text

Methods

nullValue :: Text

NullValue LocalTime

Methods

nullValue :: LocalTime

NullValue TimeOfDay

Methods

nullValue :: TimeOfDay

NullValue Day

Methods

nullValue :: Day

NullValue (Maybe a)

Methods

nullValue :: Maybe a

(NullValue a, NullValue b) => NullValue (a, b)

Methods

nullValue :: (a, b)

newtype Schema

Constructors

Schema Text