Database.Record.TH

This module defines templates for Haskell record type and type class instances to map between list of untyped SQL type and Haskell record type.

Generate all templates about record

defineRecord

Arguments

:: TypeQ

SQL value type

-> (VarName, VarName)

Constructor function name and decompose function name

-> ConName

Record type name

-> [(VarName, TypeQ)]

Column schema

-> [Name]

Record derivings

-> Q [Dec]

Result declarations

All templates for record type.

defineRecordWithConfig

Arguments

:: TypeQ

SQL value type

-> NameConfig

name rule config

-> String

Schema name

-> String

Table name

-> [(String, TypeQ)]

Column names and types

-> [Name]

Record derivings

-> Q [Dec]

Result declarations

All templates for record type with configured names.

Deriving class symbols

derivingEq :: Name

Deprecated: Use TH quasi-quotation like ''Eq instead of this.

Name to specify deriving Eq

derivingShow :: Name

Deprecated: Use TH quasi-quotation like ''Show instead of this.

Name to specify deriving Show

derivingRead :: Name

Deprecated: Use TH quasi-quotation like ''Read instead of this.

Name to specify deriving Read

derivingData :: Name

Deprecated: Use TH quasi-quotation like ''Data instead of this.

Name to specify deriving Data

derivingTypeable :: Name

Deprecated: Use TH quasi-quotation like ''Typeable instead of this.

Name to specify deriving Typeable

Table constraint specified by key

defineHasColumnConstraintInstance

Arguments

:: TypeQ

Type which represent constraint type

-> TypeQ

Type constructor of record

-> Int

Key index which specifies this constraint

-> Q [Dec]

Result declaration template

Template of HasColumnConstraint instance.

defineHasPrimaryConstraintInstanceDerived

Arguments

:: TypeQ

Type constructor of record

-> Q [Dec]

Result declaration template

Template of HasKeyConstraint instance.

defineHasPrimaryKeyInstance

Arguments

:: TypeQ

Type constructor of record

-> [Int]

Key index which specifies this constraint

-> Q [Dec]

Declaration of primary key constraint instance

Template of HasColumnConstraint Primary instance.

defineHasNotNullKeyInstance

Arguments

:: TypeQ

Type constructor of record

-> Int

Key index which specifies this constraint

-> Q [Dec]

Declaration of not null key constraint instance

Template of HasColumnConstraint NotNull instance.

Record type

defineRecordType

Arguments

:: ConName

Name of the data type of table record type.

-> [(VarName, TypeQ)]

List of columns in the table. Must be legal, properly cased record columns.

-> [Name]

Deriving type class names.

-> Q [Dec]

The data type record declaration.

Record type declaration template.

defineRecordTypeWithConfig :: NameConfig -> String -> String -> [(String, TypeQ)] -> [Name] -> Q [Dec]

Record type declaration template with configured names.

Function declarations depending on SQL type

makeRecordPersistableWithSqlType

Arguments

:: TypeQ

SQL value type.

-> (VarName, VarName)

Constructor function name and decompose function name.

-> (TypeQ, ExpQ)

Record type constructor and data constructor.

-> Int

Count of record columns.

-> Q [Dec]

Result declarations.

All templates depending on SQL value type.

makeRecordPersistableWithSqlTypeWithConfig

Arguments

:: TypeQ

SQL value type

-> NameConfig

name rule config

-> String

Schema name of database

-> String

Table name of database

-> Int

Count of record columns

-> Q [Dec]

Result declarations

All templates depending on SQL value type with configured names.

makeRecordPersistableWithSqlTypeDefault

Arguments

:: TypeQ

SQL value type

-> String

Schema name

-> String

Table name

-> Int

Count of record columns

-> Q [Dec]

Result declarations

All templates depending on SQL value type with default names.

Function declarations against defined record types

makeRecordPersistableWithSqlTypeFromDefined

Arguments

:: TypeQ

SQL value type

-> (VarName, VarName)

Constructor function name and decompose function name

-> Name

Record type constructor name

-> Q [Dec]

Result declarations

All templates depending on SQL value type. Defined record type information is used.

makeRecordPersistableWithSqlTypeDefaultFromDefined

Arguments

:: TypeQ

SQL value type

-> Name

Record type constructor name

-> Q [Dec]

Result declarations

All templates depending on SQL value type with default names. Defined record type information is used.

defineColumnOffsets

Arguments

:: ConName

Record type constructor.

-> [TypeQ]

Types of record columns.

-> Q [Dec]

Declaration of PersistableWidth instance.

Column offset array and PersistableWidth instance declaration.

recordWidthTemplate

Arguments

:: TypeQ

Record type constructor.

-> ExpQ

Expression to get record width.

Record type width expression template.

defineRecordParser

Arguments

:: TypeQ

SQL value type.

-> VarName

Name of record parser.

-> (TypeQ, ExpQ)

Record type constructor and data constructor.

-> Int

Count of record columns.

-> Q [Dec]

Declaration of record construct function from SQL values.

Record parser template.

defineRecordPrinter

Arguments

:: TypeQ

SQL value type.

-> VarName

Name of record printer.

-> (TypeQ, ExpQ)

Record type constructor and data constructor.

-> Int

Count of record columns.

-> Q [Dec]

Declaration of record construct function from SQL values.

Record printer template.

definePersistableInstance

Arguments

:: TypeQ

SQL value type.

-> TypeQ

Record type constructor.

-> VarName

Record parser name.

-> VarName

Record printer name.

-> Int

Count of record columns.

-> Q [Dec]

Instance declarations for Persistable.

Record parser and printer instance templates for converting between list of SQL type and Haskell record type.

Reify

reifyRecordType :: Name -> Q ((TypeQ, ExpQ), (Maybe [Name], [TypeQ]))

Low-level reify interface for record type name.

Templates about record type name

data NameConfig

NameConfig type to customize names of expanded record templates.

Instances

Show NameConfig

Dummy show instance. Handy to define show instance recursively.

Methods

showsPrec :: Int -> NameConfig -> ShowS

show :: NameConfig -> String

showList :: [NameConfig] -> ShowS

defaultNameConfig :: NameConfig

Default implementation of NameConfig type. To customize this, use record update syntax.

recordTypeName :: NameConfig -> String -> String -> ConName

Make record type symbol name from schema name and table name in SQL

columnName :: NameConfig -> String -> String -> VarName

Make column variable symbol name from table name and column name in SQL

recordType

Arguments

:: NameConfig

name rule config

-> String

Schema name string in SQL

-> String

Table name string in SQL

-> TypeQ

Record type constructor

Record type constructor template from SQL table name String.

columnOffsetsVarNameDefault

Arguments

:: Name

Table type name

-> VarName

Result expression variable name

Variable expression of record column offset array.

persistableFunctionNamesDefault :: Name -> (VarName, VarName)

Generate persistable function symbol names using default rule.

Not nullable single column type

deriveNotNullType :: TypeQ -> Q [Dec]

Templates for single column value type.