Database.HaskellDB.DBSpec

Portability	non-portable
Stability	experimental
Maintainer	dp03-7@mdstud.chalmers.se

Description

DBSpec is the new and improved way of specifying databases. It is designed to be able to describe a database in such a way that it can easily be converted to a DBDirect-spec OR directly into a database

$Revision: 1.8 $

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

constructNonClashingDBInfo :: DBInfo -> DBInfo

ppDBInfo :: DBInfo -> Doc

ppTInfo :: TInfo -> Doc

ppCInfo :: CInfo -> Doc

ppDBOptions :: DBOptions -> Doc

dbInfoToDoc :: DBInfo -> Doc

finalizeSpec :: DBInfo -> DBInfo

dbToDBSpec :: Bool -> String -> Database -> IO DBInfo

dbSpecToDatabase :: Database -> DBInfo -> IO ()

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

constructNonClashingDBInfo :: DBInfo -> DBInfo

Constructs a DBInfo that doesn't cause nameclashes

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.

dbToDBSpec

:: Bool	Use bounded strings?
-> String	the name our database should have
-> Database	the database connection
-> IO DBInfo	return a DBInfo
Connects to a database and generates a specification from it

dbSpecToDatabase

:: Database	A Database
-> DBInfo	The DBInfo to generate from
-> IO ()
Converts a DBInfo to a real life Database, note that the database must exist for this to work

Produced by Haddock version 0.8