Database.PostgreSQL.Simple.Bind.Representation

An algebraic data type that (partially) represents function declaration based on PostgreSQL documentation.

Documentation

data PGFunction

Representation of a PostrgeSQL function signature (schema, name, arguments, result).

Constructors

PGFunction String String [PGArgument] PGResult

Instances

Eq PGFunction

Methods

(==) :: PGFunction -> PGFunction -> Bool

(/=) :: PGFunction -> PGFunction -> Bool

Show PGFunction

Methods

showsPrec :: Int -> PGFunction -> ShowS

show :: PGFunction -> String

showList :: [PGFunction] -> ShowS

data PGArgument

Representation of a function's argument (name, type, is optional).

Constructors

PGArgument String String Bool

Instances

Eq PGArgument

Methods

(==) :: PGArgument -> PGArgument -> Bool

(/=) :: PGArgument -> PGArgument -> Bool

Show PGArgument

Methods

showsPrec :: Int -> PGArgument -> ShowS

show :: PGArgument -> String

showList :: [PGArgument] -> ShowS

data PGColumn

Representation of a resultant's column (name, type).

Constructors

PGColumn String String

Instances

Eq PGColumn

Methods

(==) :: PGColumn -> PGColumn -> Bool

(/=) :: PGColumn -> PGColumn -> Bool

Show PGColumn

Methods

showsPrec :: Int -> PGColumn -> ShowS

show :: PGColumn -> String

showList :: [PGColumn] -> ShowS

data PGResult

Representation of a function's return value.

Constructors

PGSingle String

PGSetOf String

PGTable [PGColumn]

Instances

Eq PGResult

Methods

(==) :: PGResult -> PGResult -> Bool

(/=) :: PGResult -> PGResult -> Bool

Show PGResult

Methods

showsPrec :: Int -> PGResult -> ShowS

show :: PGResult -> String

showList :: [PGResult] -> ShowS

data PostgresBindException

The exception is thrown when something goes wrong with this package.

Constructors

ParserFailed String

Thrown when parser fails to process a function declaration. Arguments of the constructor: error message from the parser.

DefaultValueNotFound String

Thrown when Argument expected to have default value while it doesn't. Actually this should never happen, but we all know...

Instances

Eq PostgresBindException

Methods

(==) :: PostgresBindException -> PostgresBindException -> Bool

(/=) :: PostgresBindException -> PostgresBindException -> Bool

Show PostgresBindException

Methods

showsPrec :: Int -> PostgresBindException -> ShowS

show :: PostgresBindException -> String

showList :: [PostgresBindException] -> ShowS

Exception PostgresBindException

Methods

toException :: PostgresBindException -> SomeException

fromException :: SomeException -> Maybe PostgresBindException

displayException :: PostgresBindException -> String

parsePGFunction :: MonadThrow m => Text -> m PGFunction

Takes PostgreSQL function signature and represent it as an algebraic data type.