Database.PostgreSQL.Simple.Bind

Description

postgresql-simple-bind is an extension for postgresql-simple library that faciliates and automates bindings creation. This is especially useful in a design pattern where an application communicates with a database via API hiding the internal structure of the latter.

Documentation

bindFunction :: PostgresBindOptions -> Text -> Q [Dec]

Function that constructs binding for PostgreSQL stored function by it's signature.

data PostgresBindOptions

Options that specify how to construct the function binding.

Constructors

PostgresBindOptions

Fields

• pboFunctionName :: PGFunction -> String

  Function that generates name of a binding.

• pboIsNullable :: String -> String -> Bool

  Which columns in returned tables can be null.

• pboSetOfReturnType :: String -> ReturnType

  How to process type in "setof" clause.

Instances

Default PostgresBindOptions

Methods

def :: PostgresBindOptions

data ReturnType

How to interpret results of function execution.

Constructors

AsRow

AsField

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

type family PostgresType (a :: Symbol)

Mapping from PostgreSQL types to Haskell types.

Instances

type PostgresType "bigint"

type PostgresType "bigint" = Int

type PostgresType "character varying"

type PostgresType "character varying" = Text

type PostgresType "timestamp with time zone"

type PostgresType "timestamp with time zone" = UTCTime

type PostgresType "timestamptz"

type PostgresType "timestamptz" = UTCTime

type PostgresType "varchar"

type PostgresType "varchar" = Text

type PostgresType "void"

type PostgresType "void" = ()

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