Database.PostgreSQL.Store

Errand

data Errand a

An interaction with the database

Instances

Monad Errand

Methods

(>>=) :: Errand a -> (a -> Errand b) -> Errand b

(>>) :: Errand a -> Errand b -> Errand b

return :: a -> Errand a

fail :: String -> Errand a

Functor Errand

Methods

fmap :: (a -> b) -> Errand a -> Errand b

(<$) :: a -> Errand b -> Errand a

Applicative Errand

Methods

pure :: a -> Errand a

(<*>) :: Errand (a -> b) -> Errand a -> Errand b

(*>) :: Errand a -> Errand b -> Errand b

(<*) :: Errand a -> Errand b -> Errand a

Alternative Errand

Methods

empty :: Errand a

(<|>) :: Errand a -> Errand a -> Errand a

some :: Errand a -> Errand [a]

many :: Errand a -> Errand [a]

MonadIO Errand

Methods

liftIO :: IO a -> Errand a

MonadError ErrandError Errand

Methods

throwError :: ErrandError -> Errand a

catchError :: Errand a -> (ErrandError -> Errand a) -> Errand a

runErrand :: Connection -> Errand a -> IO (Either ErrandError a)

Run an errand.

execute :: ErrandQuery q Result => q r -> ErrandResult q Result

Execute the query and return its internal result.

execute' :: ErrandQuery q Int => q r -> ErrandResult q Int

Same as execute but instead of a Result it returns the number of affected rows.

query :: (Entity r, ErrandQuery q [r]) => q r -> ErrandResult q [r]

Execute a query and process its result set.

queryWith :: (ErrandQuery q [r], KnownNat n) => RowParser n r -> q r -> ErrandResult q [r]

Execute a query and process its result set using the provided RowParser.

prepare :: PrepQuery a r -> Errand ()

Prepare a preparable query.

beginTransaction :: Errand ()

Begin a transaction.

commitTransaction :: Errand ()

Commit transaction.

saveTransaction :: ByteString -> Errand ()

Create savepoint within transaction.

rollbackTransaction :: Errand ()

Roll back transaction.

rollbackTransactionTo :: ByteString -> Errand ()

Roll back to a specific savepoint.

withTransaction :: Errand a -> Errand ()

Do something within a transaction.

Query

data Query a

Query object

Constructors

Query

Fields

• queryStatement :: ByteString

  SQL statement

• queryParams :: [Maybe (Oid, ByteString, Format)]

  Parameters

Instances

ErrandQuery Query r

Associated Types

type ErrandResult (Query :: * -> *) r :: *

Methods

executeWith :: (Result -> Errand r) -> Query x -> ErrandResult Query r

Eq (Query a)

Methods

(==) :: Query a -> Query a -> Bool

(/=) :: Query a -> Query a -> Bool

Ord (Query a)

Methods

compare :: Query a -> Query a -> Ordering

(<) :: Query a -> Query a -> Bool

(<=) :: Query a -> Query a -> Bool

(>) :: Query a -> Query a -> Bool

(>=) :: Query a -> Query a -> Bool

max :: Query a -> Query a -> Query a

min :: Query a -> Query a -> Query a

Show (Query a)

Methods

showsPrec :: Int -> Query a -> ShowS

show :: Query a -> String

showList :: [Query a] -> ShowS

type ErrandResult Query r

type ErrandResult Query r = Errand r

data PrepQuery ts a

Preparable query object

Constructors

PrepQuery

Fields

• prepName :: ByteString

  Name of the prepared statement

• prepStatement :: ByteString

  SQL statement

• prepOids :: [Oid]

  Parameter type hints

• prepParams :: Tuple ts -> [Maybe (ByteString, Format)]

  Parameter generator

Instances

WithTuple ts => ErrandQuery (PrepQuery ts) r

Associated Types

type ErrandResult (PrepQuery ts :: * -> *) r :: *

Methods

executeWith :: (Result -> Errand r) -> PrepQuery ts x -> ErrandResult (PrepQuery ts) r

Show (PrepQuery ts a)

Methods

showsPrec :: Int -> PrepQuery ts a -> ShowS

show :: PrepQuery ts a -> String

showList :: [PrepQuery ts a] -> ShowS

type ErrandResult (PrepQuery ts) r

type ErrandResult (PrepQuery ts) r = Function ts (Errand r)

pgQuery :: QuasiQuoter

Generate a Query. This utilizes an intermediate query generator of type QueryGenerator ().

See Database.PostgreSQL.Store.Query.TH for detailed description of the language accepted by this quasi quoter.

pgPrepQuery :: QuasiQuoter

Generate a PrepQuery. The intermediate query generator has type QueryGenerator (Tuple ts) where ts has kind [Type]. ts represents the types of the parameters to this prepared query.

It is highly recommended that supply a type signature, if you give the resulting expression a name, to avoid ambiguity.

q :: PrepQuery '[Int, String] User
q = [pgPrepQuery| SELECT #User(u) FROM @User u WHERE age < $(param0) AND name LIKE $(param1) |]

See Database.PostgreSQL.Store.Query.TH for detailed description of the language accepted by this quasi quoter.

pgQueryGen :: QuasiQuoter

Generate a QueryGenerator expression.

See Database.PostgreSQL.Store.Query.TH for detailed description of the language accepted by this quasi quoter.

Types

newtype Oid :: *

Constructors

Oid CUInt

Instances

Eq Oid

Methods

(==) :: Oid -> Oid -> Bool

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

Ord Oid

Methods

compare :: Oid -> Oid -> Ordering

(<) :: Oid -> Oid -> Bool

(<=) :: Oid -> Oid -> Bool

(>) :: Oid -> Oid -> Bool

(>=) :: Oid -> Oid -> Bool

max :: Oid -> Oid -> Oid

min :: Oid -> Oid -> Oid

Read Oid

Methods

readsPrec :: Int -> ReadS Oid

readList :: ReadS [Oid]

readPrec :: ReadPrec Oid

readListPrec :: ReadPrec [Oid]

Show Oid

Methods

showsPrec :: Int -> Oid -> ShowS

show :: Oid -> String

showList :: [Oid] -> ShowS

Storable Oid

Methods

sizeOf :: Oid -> Int

alignment :: Oid -> Int

peekElemOff :: Ptr Oid -> Int -> IO Oid

pokeElemOff :: Ptr Oid -> Int -> Oid -> IO ()

peekByteOff :: Ptr b -> Int -> IO Oid

pokeByteOff :: Ptr b -> Int -> Oid -> IO ()

peek :: Ptr Oid -> IO Oid

poke :: Ptr Oid -> Oid -> IO ()

Entity

class KnownNat (Width a) => Entity a where

An entity that is used as a parameter or result of a query.

Associated Types

type Width a :: Nat

Number of values of which the entity consists

Methods

genEntity :: QueryGenerator a

Embed the entity into the query.

genEntity :: (Generic a, GEntity (Rep a)) => QueryGenerator a

Embed the entity into the query.

parseEntity :: RowParser (Width a) a

Retrieve an instance of a from the result set.

parseEntity :: (Generic a, GEntity (Rep a), Width a ~ GEntityWidth (Rep a)) => RowParser (Width a) a

Retrieve an instance of a from the result set.

Instances

Entity Bool

boolean

Associated Types

type Width Bool :: Nat

Methods

genEntity :: QueryGenerator Bool

parseEntity :: RowParser (Width Bool) Bool

Entity Double

Any floating-point number

Associated Types

type Width Double :: Nat

Methods

genEntity :: QueryGenerator Double

parseEntity :: RowParser (Width Double) Double

Entity Float

Any floating-point number

Associated Types

type Width Float :: Nat

Methods

genEntity :: QueryGenerator Float

parseEntity :: RowParser (Width Float) Float

Entity Int

Any integer

Associated Types

type Width Int :: Nat

Methods

genEntity :: QueryGenerator Int

parseEntity :: RowParser (Width Int) Int

Entity Int8

Any integer

Associated Types

type Width Int8 :: Nat

Methods

genEntity :: QueryGenerator Int8

parseEntity :: RowParser (Width Int8) Int8

Entity Int16

Any integer

Associated Types

type Width Int16 :: Nat

Methods

genEntity :: QueryGenerator Int16

parseEntity :: RowParser (Width Int16) Int16

Entity Int32

Any integer

Associated Types

type Width Int32 :: Nat

Methods

genEntity :: QueryGenerator Int32

parseEntity :: RowParser (Width Int32) Int32

Entity Int64

Any integer

Associated Types

type Width Int64 :: Nat

Methods

genEntity :: QueryGenerator Int64

parseEntity :: RowParser (Width Int64) Int64

Entity Integer

Any integer

Associated Types

type Width Integer :: Nat

Methods

genEntity :: QueryGenerator Integer

parseEntity :: RowParser (Width Integer) Integer

Entity Word

Any unsigned integer

Associated Types

type Width Word :: Nat

Methods

genEntity :: QueryGenerator Word

parseEntity :: RowParser (Width Word) Word

Entity Word8

Any unsigned integer

Associated Types

type Width Word8 :: Nat

Methods

genEntity :: QueryGenerator Word8

parseEntity :: RowParser (Width Word8) Word8

Entity Word16

Any unsigned integer

Associated Types

type Width Word16 :: Nat

Methods

genEntity :: QueryGenerator Word16

parseEntity :: RowParser (Width Word16) Word16

Entity Word32

Any unsigned integer

Associated Types

type Width Word32 :: Nat

Methods

genEntity :: QueryGenerator Word32

parseEntity :: RowParser (Width Word32) Word32

Entity Word64

Any unsigned integer

Associated Types

type Width Word64 :: Nat

Methods

genEntity :: QueryGenerator Word64

parseEntity :: RowParser (Width Word64) Word64

Entity ByteString

bytea - byte array encoded in hex format

Associated Types

type Width ByteString :: Nat

Methods

genEntity :: QueryGenerator ByteString

parseEntity :: RowParser (Width ByteString) ByteString

Entity ByteString

bytea - byte array encoded in hex format

Associated Types

type Width ByteString :: Nat

Methods

genEntity :: QueryGenerator ByteString

parseEntity :: RowParser (Width ByteString) ByteString

Entity Scientific

Any numeric type

Associated Types

type Width Scientific :: Nat

Methods

genEntity :: QueryGenerator Scientific

parseEntity :: RowParser (Width Scientific) Scientific

Entity String

char, varchar or text - UTF-8 encoded; does not allow NULL characters

Associated Types

type Width String :: Nat

Methods

genEntity :: QueryGenerator String

parseEntity :: RowParser (Width String) String

Entity Text

char, varchar or text - UTF-8 encoded; does not allow NULL characters

Associated Types

type Width Text :: Nat

Methods

genEntity :: QueryGenerator Text

parseEntity :: RowParser (Width Text) Text

Entity Value

json or jsonb

Associated Types

type Width Value :: Nat

Methods

genEntity :: QueryGenerator Value

parseEntity :: RowParser (Width Value) Value

Entity Text

char, varchar or text - UTF-8 encoded; does not allow NULL characters

Associated Types

type Width Text :: Nat

Methods

genEntity :: QueryGenerator Text

parseEntity :: RowParser (Width Text) Text

Entity Natural

Any unsigned integer

Associated Types

type Width Natural :: Nat

Methods

genEntity :: QueryGenerator Natural

parseEntity :: RowParser (Width Natural) Natural

Entity a => Entity (Maybe a)

A value which may be NULL.

Associated Types

type Width (Maybe a) :: Nat

Methods

genEntity :: QueryGenerator (Maybe a)

parseEntity :: RowParser (Width (Maybe a)) (Maybe a)

GenericEntity (a, b) => Entity (a, b)

Chain of 2 entities

Associated Types

type Width (a, b) :: Nat

Methods

genEntity :: QueryGenerator (a, b)

parseEntity :: RowParser (Width (a, b)) (a, b)

GenericEntity (a, b, c) => Entity (a, b, c)

Chain of 3 entities

Associated Types

type Width (a, b, c) :: Nat

Methods

genEntity :: QueryGenerator (a, b, c)

parseEntity :: RowParser (Width (a, b, c)) (a, b, c)

GenericEntity (a, b, c, d) => Entity (a, b, c, d)

Chain of 4 entities

Associated Types

type Width (a, b, c, d) :: Nat

Methods

genEntity :: QueryGenerator (a, b, c, d)

parseEntity :: RowParser (Width (a, b, c, d)) (a, b, c, d)

GenericEntity (a, b, c, d, e) => Entity (a, b, c, d, e)

Chain of 5 entities

Associated Types

type Width (a, b, c, d, e) :: Nat

Methods

genEntity :: QueryGenerator (a, b, c, d, e)

parseEntity :: RowParser (Width (a, b, c, d, e)) (a, b, c, d, e)

GenericEntity (a, b, c, d, e, f) => Entity (a, b, c, d, e, f)

Chain of 6 entities

Associated Types

type Width (a, b, c, d, e, f) :: Nat

Methods

genEntity :: QueryGenerator (a, b, c, d, e, f)

parseEntity :: RowParser (Width (a, b, c, d, e, f)) (a, b, c, d, e, f)

GenericEntity (a, b, c, d, e, f, g) => Entity (a, b, c, d, e, f, g)

Chain of 7 entities

Associated Types

type Width (a, b, c, d, e, f, g) :: Nat

Methods

genEntity :: QueryGenerator (a, b, c, d, e, f, g)

parseEntity :: RowParser (Width (a, b, c, d, e, f, g)) (a, b, c, d, e, f, g)

Tables

data Table

Description of a table

Constructors

Table

Fields

• tableName :: ByteString

  Table name

• tableCols :: [ByteString]

  Table columns

Instances

Eq Table

Methods

(==) :: Table -> Table -> Bool

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

Ord Table

Methods

compare :: Table -> Table -> Ordering

(<) :: Table -> Table -> Bool

(<=) :: Table -> Table -> Bool

(>) :: Table -> Table -> Bool

(>=) :: Table -> Table -> Bool

max :: Table -> Table -> Table

min :: Table -> Table -> Table

Show Table

Methods

showsPrec :: Int -> Table -> ShowS

show :: Table -> String

showList :: [Table] -> ShowS

class Entity a => TableEntity a where

Table entity with extra information about its name and column names

Methods

describeTableType :: Tagged a Table

Describe the table type.

describeTableType :: GenericTable a => Tagged a Table

Describe the table type.

Errors

data ErrandError

Error during errand

Constructors

NoResult

No Result has been returned.

UserError String

A user has thrown an error.

ExecError ExecStatus ErrorCode ByteString ByteString ByteString

Query execution failed.

ParseError RowError

Result processing failed.

Instances

Eq ErrandError

Methods

(==) :: ErrandError -> ErrandError -> Bool

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

Show ErrandError

Methods

showsPrec :: Int -> ErrandError -> ShowS

show :: ErrandError -> String

showList :: [ErrandError] -> ShowS

Monoid ErrandError

Methods

mempty :: ErrandError

mappend :: ErrandError -> ErrandError -> ErrandError

mconcat :: [ErrandError] -> ErrandError

MonadError ErrandError Errand

Methods

throwError :: ErrandError -> Errand a

catchError :: Errand a -> (ErrandError -> Errand a) -> Errand a

data ErrorCode

Error codes

Constructors

UnknownErrorCause ByteString

IntegrityViolation

RestrictViolation

NotNullViolation

ForeignKeyViolation

UniqueViolation

CheckViolation

ExclusionViolation

Instances

Eq ErrorCode

Methods

(==) :: ErrorCode -> ErrorCode -> Bool

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

Show ErrorCode

Methods

showsPrec :: Int -> ErrorCode -> ShowS

show :: ErrorCode -> String

showList :: [ErrorCode] -> ShowS

data ExecStatus :: *

Constructors

EmptyQuery

The string sent to the server was empty.

CommandOk

Successful completion of a command returning no data.

TuplesOk

Successful completion of a command returning data (such as a SELECT or SHOW).

CopyOut

Copy Out (from server) data transfer started.

CopyIn

Copy In (to server) data transfer started.

CopyBoth

Copy In/Out data transfer started.

BadResponse

The server's response was not understood.

NonfatalError

A nonfatal error (a notice or warning) occurred.

FatalError

A fatal error occurred.

SingleTuple

The PGresult contains a single result tuple from the current command. This status occurs only when single-row mode has been selected for the query.

Instances

Enum ExecStatus

Methods

succ :: ExecStatus -> ExecStatus

pred :: ExecStatus -> ExecStatus

toEnum :: Int -> ExecStatus

fromEnum :: ExecStatus -> Int

enumFrom :: ExecStatus -> [ExecStatus]

enumFromThen :: ExecStatus -> ExecStatus -> [ExecStatus]

enumFromTo :: ExecStatus -> ExecStatus -> [ExecStatus]

enumFromThenTo :: ExecStatus -> ExecStatus -> ExecStatus -> [ExecStatus]

Eq ExecStatus

Methods

(==) :: ExecStatus -> ExecStatus -> Bool

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

Show ExecStatus

Methods

showsPrec :: Int -> ExecStatus -> ShowS

show :: ExecStatus -> String

showList :: [ExecStatus] -> ShowS

data RowError

An error that occured when parsing a row

Constructors

RowError RowErrorLocation RowErrorDetail

Instances

Eq RowError

Methods

(==) :: RowError -> RowError -> Bool

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

Ord RowError

Methods

compare :: RowError -> RowError -> Ordering

(<) :: RowError -> RowError -> Bool

(<=) :: RowError -> RowError -> Bool

(>) :: RowError -> RowError -> Bool

(>=) :: RowError -> RowError -> Bool

max :: RowError -> RowError -> RowError

min :: RowError -> RowError -> RowError

Show RowError

Methods

showsPrec :: Int -> RowError -> ShowS

show :: RowError -> String

showList :: [RowError] -> ShowS

data RowErrorLocation

Location of an error

Constructors

RowErrorLocation Column Row

Instances

Eq RowErrorLocation

Methods

(==) :: RowErrorLocation -> RowErrorLocation -> Bool

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

Ord RowErrorLocation

Methods

compare :: RowErrorLocation -> RowErrorLocation -> Ordering

(<) :: RowErrorLocation -> RowErrorLocation -> Bool

(<=) :: RowErrorLocation -> RowErrorLocation -> Bool

(>) :: RowErrorLocation -> RowErrorLocation -> Bool

(>=) :: RowErrorLocation -> RowErrorLocation -> Bool

max :: RowErrorLocation -> RowErrorLocation -> RowErrorLocation

min :: RowErrorLocation -> RowErrorLocation -> RowErrorLocation

Show RowErrorLocation

Methods

showsPrec :: Int -> RowErrorLocation -> ShowS

show :: RowErrorLocation -> String

showList :: [RowErrorLocation] -> ShowS

data RowErrorDetail

Errors that occur during row parsing

Constructors

TooFewColumns

Underlying RowParser wants more columns than are currently present.

ColumnRejected

A column value could not be parsed.

Instances

Eq RowErrorDetail

Methods

(==) :: RowErrorDetail -> RowErrorDetail -> Bool

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

Ord RowErrorDetail

Methods

compare :: RowErrorDetail -> RowErrorDetail -> Ordering

(<) :: RowErrorDetail -> RowErrorDetail -> Bool

(<=) :: RowErrorDetail -> RowErrorDetail -> Bool

(>) :: RowErrorDetail -> RowErrorDetail -> Bool

(>=) :: RowErrorDetail -> RowErrorDetail -> Bool

max :: RowErrorDetail -> RowErrorDetail -> RowErrorDetail

min :: RowErrorDetail -> RowErrorDetail -> RowErrorDetail

Show RowErrorDetail

Methods

showsPrec :: Int -> RowErrorDetail -> ShowS

show :: RowErrorDetail -> String

showList :: [RowErrorDetail] -> ShowS