haskelldb-0.10: SQL unwrapper for Haskell. Contents Index

Database.HaskellDB.DBSpec.DBInfo Portability non-portable Stability experimental Maintainer haskelldb-users@lists.sourceforge.net

Description

This is the core file of the DBSpec files. It defines a DBInfo and important functions on it.

Synopsis

data DBInfo = DBInfo { dbname :: String opts :: DBOptions tbls :: [TInfo] } data TInfo = TInfo { tname :: String cols :: [CInfo] } data CInfo = CInfo { cname :: String descr :: FieldDesc } data DBOptions = DBOptions { useBString :: Bool } 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

data DBInfo

Defines a database layout, top level Constructors DBInfo dbname :: String The name of the database opts :: DBOptions Any options (i.e whether to use Bounded Strings) tbls :: [TInfo] Tables this database contains Instances Eq DBInfo Show DBInfo

data TInfo

Constructors TInfo tname :: String The name of the table cols :: [CInfo] The columns in this table Instances Eq TInfo Show TInfo

data CInfo

Constructors CInfo cname :: String The name of this column descr :: FieldDesc The description of this column Instances Eq CInfo Show CInfo

data DBOptions

Constructors DBOptions useBString :: Bool Use Bounded Strings? Instances Eq DBOptions Show DBOptions

makeDBSpec

:: String The name of the Database -> DBOptions Options -> [TInfo] Tables -> DBInfo The generated DBInfo Creates a DBInfo

makeTInfo

:: String The table name -> [CInfo] Columns -> TInfo The generated TInfo Creates a TInfo

makeCInfo

:: String The column name -> FieldDesc What the column contains -> CInfo The generated CInfo Creates a CInfo

ppDBInfo :: DBInfo -> Doc

Pretty prints a DBInfo

ppTInfo :: TInfo -> Doc

ppCInfo :: CInfo -> Doc

ppDBOptions :: DBOptions -> Doc

dbInfoToDoc :: DBInfo -> Doc

Creates a valid declaration of a DBInfo. The variable name will be the same as the database name

finalizeSpec :: DBInfo -> DBInfo

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 -> DBInfo

Constructs a DBInfo that doesn't cause nameclashes

Produced by Haddock version 0.8