Portability | non-portable |
---|---|
Stability | experimental |
Maintainer | [email protected] |
Safe Haskell | None |
Database.HaskellDB.DBSpec.DBInfo
Description
This is the core file of the DBSpec files. It defines a DBInfo and important functions on it.
- data DBInfo = DBInfo {}
- data TInfo = TInfo {}
- data CInfo = CInfo {}
- data DBOptions = DBOptions {
- useBString :: Bool
- makeIdent :: MakeIdentifiers
- makeDBSpec :: String -> DBOptions -> [TInfo] -> DBInfo
- makeTInfo :: String -> [CInfo] -> TInfo
- makeCInfo :: String -> FieldDesc -> CInfo
- ppDBInfo :: DBInfo -> Doc
- ppTInfo :: TInfo -> Doc
- ppCInfo :: CInfo -> Doc
- ppDBOptions :: DBOptions -> Doc
- dbInfoToDoc :: DBInfo -> Doc
- finalizeSpec :: DBInfo -> DBInfo
- constructNonClashingDBInfo :: DBInfo -> DBInfo
Documentation
Constructors
TInfo | |
Constructors
CInfo | |
Constructors
DBOptions | |
Fields
|
Instances
Show DBOptions |
Arguments
:: String | The name of the Database |
-> DBOptions | Options |
-> [TInfo] | Tables |
-> DBInfo | The generated DBInfo |
Creates a DBInfo
Creates a TInfo
Creates a CInfo
ppDBOptions :: DBOptions -> DocSource
dbInfoToDoc :: DBInfo -> DocSource
Creates a valid declaration of a DBInfo. The variable name will be the same as the database name
finalizeSpec :: DBInfo -> DBInfoSource
Does a final touching up of a DBInfo before it is used by i.e DBDirect. This converts any Bounded Strings to ordinary strings if that flag is set.
constructNonClashingDBInfo :: DBInfo -> DBInfoSource
Constructs a DBInfo that doesn't cause nameclashes