| Copyright | 2013 Kei Hibino |
|---|---|
| License | BSD3 |
| Maintainer | ex8k.hibino@gmail.com |
| Stability | experimental |
| Portability | unknown |
| Safe Haskell | None |
| Language | Haskell2010 |
Database.Record.TH
Contents
Description
This module defines templates for Haskell record type and type class instances to map between list of untyped SQL type and Haskell record type.
- defineRecord :: TypeQ -> (VarName, VarName) -> ConName -> [(VarName, TypeQ)] -> [Name] -> Q [Dec]
- defineRecordDefault :: TypeQ -> String -> [(String, TypeQ)] -> [Name] -> Q [Dec]
- derivingEq :: Name
- derivingShow :: Name
- derivingRead :: Name
- derivingData :: Name
- derivingTypeable :: Name
- defineHasColumnConstraintInstance :: TypeQ -> TypeQ -> Int -> Q [Dec]
- defineHasPrimaryConstraintInstanceDerived :: TypeQ -> Q [Dec]
- defineHasNotNullKeyInstance :: TypeQ -> Int -> Q [Dec]
- defineHasPrimaryKeyInstance :: TypeQ -> [Int] -> Q [Dec]
- defineHasPrimaryKeyInstanceDefault :: String -> [Int] -> Q [Dec]
- defineHasNotNullKeyInstanceDefault :: String -> Int -> Q [Dec]
- defineRecordType :: ConName -> [(VarName, TypeQ)] -> [Name] -> Q [Dec]
- defineRecordTypeDefault :: String -> [(String, TypeQ)] -> [Name] -> Q [Dec]
- makeRecordPersistableWithSqlType :: TypeQ -> (VarName, VarName) -> (TypeQ, ExpQ) -> Int -> Q [Dec]
- makeRecordPersistableWithSqlTypeDefault :: TypeQ -> String -> Int -> Q [Dec]
- makeRecordPersistableWithSqlTypeFromDefined :: TypeQ -> (VarName, VarName) -> Name -> Q [Dec]
- makeRecordPersistableWithSqlTypeDefaultFromDefined :: TypeQ -> Name -> Q [Dec]
- defineColumnOffsets :: ConName -> [TypeQ] -> Q [Dec]
- recordWidthTemplate :: TypeQ -> ExpQ
- defineRecordParser :: TypeQ -> VarName -> (TypeQ, ExpQ) -> Int -> Q [Dec]
- defineRecordPrinter :: TypeQ -> VarName -> (TypeQ, ExpQ) -> Int -> Q [Dec]
- definePersistableInstance :: TypeQ -> TypeQ -> VarName -> VarName -> Int -> Q [Dec]
- reifyRecordType :: Name -> Q ((TypeQ, ExpQ), (Maybe [Name], [TypeQ]))
- recordTypeNameDefault :: String -> ConName
- recordTypeDefault :: String -> TypeQ
- columnOffsetsVarNameDefault :: Name -> VarName
- persistableFunctionNamesDefault :: Name -> (VarName, VarName)
- deriveNotNullType :: TypeQ -> Q [Dec]
Generate all templates about record
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.
Arguments
| :: TypeQ | SQL value type |
| -> String | Table name |
| -> [(String, TypeQ)] | Column names and types |
| -> [Name] | Record derivings |
| -> Q [Dec] | Result declarations |
All templates for record type with default names.
Deriving class symbols
derivingEq :: Name Source
Deprecated: Use TH quasi-quotation like ''Eq instead of this.
Name to specify deriving Eq
Deprecated: Use TH quasi-quotation like ''Show instead of this.
Name to specify deriving Show
Deprecated: Use TH quasi-quotation like ''Read instead of this.
Name to specify deriving Read
Deprecated: Use TH quasi-quotation like ''Data instead of this.
Name to specify deriving Data
derivingTypeable :: Name Source
Deprecated: Use TH quasi-quotation like ''Typeable instead of this.
Name to specify deriving Typeable
Table constraint specified by key
defineHasColumnConstraintInstance Source
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 Source
Template of HasKeyConstraint instance.
defineHasNotNullKeyInstance Source
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.
defineHasPrimaryKeyInstance Source
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.
defineHasPrimaryKeyInstanceDefault Source
Arguments
| :: String | Table name |
| -> [Int] | Key index which specifies this constraint |
| -> Q [Dec] | Declaration of primary key constraint instance |
Template of HasColumnConstraint Primary instance
from SQL table name String and key index.
defineHasNotNullKeyInstanceDefault Source
Arguments
| :: String | Table name |
| -> Int | Key index which specifies this constraint |
| -> Q [Dec] | Declaration of not null key constraint instance |
Template of HasColumnConstraint NotNull instance
from SQL table name String and key index.
Record type
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.
Function declarations depending on SQL type
makeRecordPersistableWithSqlType Source
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.
makeRecordPersistableWithSqlTypeDefault Source
Arguments
| :: TypeQ | SQL value type |
| -> String | Table name of database |
| -> 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 Source
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 Source
All templates depending on SQL value type with default names. Defined record type information is used.
Arguments
| :: ConName | Record type constructor. |
| -> [TypeQ] | Types of record columns. |
| -> Q [Dec] | Declaration of |
Column offset array and PersistableWidth instance declaration.
Record type width expression template.
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.
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 Source
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 |
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])) Source
Low-level reify interface for record type name.
Templates about record type name
Generate default name of record type constructor from SQL table name String
Record type constructor template from SQL table name String.
Type name is generated by recordTypeNameDefault.
columnOffsetsVarNameDefault Source
Variable expression of record column offset array.
persistableFunctionNamesDefault :: Name -> (VarName, VarName) Source
Generate persistable function symbol names using default rule.
Not nullable single column type
deriveNotNullType :: TypeQ -> Q [Dec] Source
Templates for single column value type.