Database.HaskellDB.DBSpec.DBInfo

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

Documentation

data DBInfo

Defines a database layout, top level

Constructors

DBInfo

Fields

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

Show DBInfo

data TInfo

Constructors

TInfo

Fields

tname :: String

The name of the table

cols :: [CInfo]

The columns in this table

Instances

Eq TInfo

Show TInfo

data CInfo

Constructors

CInfo

Fields

cname :: String

The name of this column

descr :: FieldDesc

The description of this column

Instances

Eq CInfo

Show CInfo

data DBOptions

Constructors

DBOptions

Fields

useBString :: Bool

Use Bounded Strings?

makeIdent :: MakeIdentifiers

Conversion routines from Database identifiers to Haskell identifiers

Instances

Show DBOptions

makeDBSpec

Arguments

:: String

The name of the Database

-> DBOptions

Options

-> [TInfo]

Tables

-> DBInfo

The generated DBInfo

Creates a DBInfo

makeTInfo

Arguments

:: String

The table name

-> [CInfo]

Columns

-> TInfo

The generated TInfo

Creates a TInfo

makeCInfo

Arguments

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