Internal.Data.Basic.TH.Helper

module Internal. : Data.Basic.TH.Types Description : Data types and utility function used during TH generation phase License : MIT

This module Internal.contains helper functions that are used in code generation process.

Documentation

liftError :: Throws ParseError m => Either ParseErrorExtra a -> m a

listToTypeLevel :: [Type] -> Type

lifts a list of types to a type level (i.e. typelevel list) e.g. `listToTypeLeve [Int, String, Double] = '[ Int, String, Double ]`

addFields :: Exp -> Int -> Exp

Used to append n times `$ field` to the expression

addField :: Exp -> Exp

Used to append `$ field` at the end of the expression

standardizeName :: Text -> Text

quasyPlural :: Text -> Text

returns a plural of a known noun. Basically just appends s or es

nameUnnamedConstraints :: Throws ParseError m => EntityInfo -> m EntityInfo

Tries to name multiples constraints

nameUnnamedConstraint :: Throws ParseError m => EntityInfo -> Constraint -> m Constraint

Mechanism for naming unnamed constraints. If a constraint cannot be named, an error is trown

nameConstraint :: Text -> [NameComponent] -> Text

Provides default naming scheme for constraints

getName :: Name -> Text

Converts a Name to a plain text @TODO test complex naming schemes

getOptionalColumns :: ParseContext -> EntityInfo -> [ColumnInfo]

Retrieves a list of optional columns in an entity

getEntityByName :: Throws ParseError m => Name -> [EntityInfo] -> m EntityInfo

Tries to retrieve entity information. If an entity with that name doesn't exist an error is thrown.

getEntityBySQLName :: Throws ParseError m => Name -> [EntityInfo] -> m EntityInfo

Tries to retrieve entity information. If an entity with that name doesn't exist an error is thrown.

getColumn :: Throws ParseError m => EntityInfo -> Text -> m ColumnInfo

Tries to retrieve column information from entity. If a column with that name doesn't exist an error is thrown.

lowerFirst :: Text -> Text

upperFirst :: Text -> Text

getEntityPrimaryKey :: ParseContext -> EntityInfo -> Maybe PrimaryKeyConstraint

Retrieves the primary key for an entity from ParseContext

columnNameToLensName :: Text -> Text

Generates name for the column lens (i.e. lowercases first letter)