PostgreSQL

PostgreSQL client

Have a look at the individual sub-sections to find out more about the respective concepts.

Templates and statements

Writing a statement usually involves writing it as a Template and then rendering it as a Statement. The latter can optionally be prepared to become a PreparedStatement.

Templates and statements can take an input. The type of that input is determined by the type parameter that Template, Statement and 'Statement.PreparedStatement expose.

Templates

Templates can be constructed using the tpl quasi-quoter or manually using the provided combinators.

data Template a

SQL statement template

Since: 0.0.0

Instances

Contravariant Template

Since: 0.0.0

Defined in PostgreSQL.Statement

Methods

contramap :: (a -> b) -> Template b -> Template a

(>$) :: b -> Template b -> Template a

(HasField n r a, Param a) => IsLabel n (Template r)

OverloadedLabels helper for param

#myParam === param (getField @"myParam")

Use this with a database:

data MyFoo = MyFoo { bar :: Int, baz :: String }

myStatementTpl :: Template MyFoo
myStatementTpl = "SELECT * FROM my_foo WHERE bar = " <> #bar <> " AND baz = " <> #baz

Since: 0.0.0

Defined in PostgreSQL.Statement

Methods

fromLabel :: Template r

IsString (Template a)

OverloadedStrings helper for code

"my code" === code "my code"

Since: 0.0.0

Defined in PostgreSQL.Statement

Methods

fromString :: String -> Template a

Semigroup (Template a)

Since: 0.0.0

Defined in PostgreSQL.Statement

Methods

(<>) :: Template a -> Template a -> Template a

sconcat :: NonEmpty (Template a) -> Template a

stimes :: Integral b => b -> Template a -> Template a

Monoid (Template a)

Since: 0.0.0

Defined in PostgreSQL.Statement

Methods

mempty :: Template a

mappend :: Template a -> Template a -> Template a

mconcat :: [Template a] -> Template a

renderTemplate :: Template a -> Statement a

Render the SQL statement.

Since: 0.0.0

Quasi-quotation

tpl :: QuasiQuoter

Produces a Template expression.

Supports the same features as stmt.

Since: 0.0.0

Combinators

Template implements Semigroup and Monoid. These can be used to compose the following combinators.

It also supports IsString which helps to create templates from string literals.

You may use overloaded labels to refer to parameters.

#my_param === param my_param

my_param shall be a record field of data type.

code :: Text -> Template a

Create a code-only statement.

Since: 0.0.0

identifier :: Text -> Template a

Create a code segment that mentions the given identifier (e.g. table or column name).

Since: 0.0.0

string :: Text -> Template a

Encase the given string literal in single quotes. Single quotes in the literal are automatically escaped.

Since: 0.0.0

param :: forall b a. Param b => (a -> b) -> Template a

Reference a parameter.

Since: 0.0.0

paramWith :: Info (a -> Value) -> Template a

Reference a parameter.

Since: 0.0.0

constant :: forall b a. Param b => b -> Template a

Constant part of a query.

Since: 0.0.0

Statements

Statements are created using the stmt quasi-quoter or by rendering a Template via renderTemplate.

data Statement a

Rendered SQL statement

Since: 0.0.0

Instances

Contravariant Statement

Since: 0.0.0

Defined in PostgreSQL.Statement

Methods

contramap :: (a -> b) -> Statement b -> Statement a

(>$) :: b -> Statement b -> Statement a

Executable Statement

Since: 0.0.0

Defined in PostgreSQL.Query.Class

Methods

execute :: Query query => Statement param -> param -> query (NativeResult query)

stmt :: QuasiQuoter

Produces a Statement expression.

[stmt| SELECT $param * 2 |]

Use $$ to render a single $.

Parameters

Use $param or ${param} to reference a query parameter.

[stmt| ${x} |] is equivalent to param x.

Substitutions

Use $(substr) to embed another Template where substr :: Template a.

[stmt| $(x) |] is equivalent to x.

Examples

data MyParams = MyParams { foo :: Int, bar :: Text }

myStatement :: Statement MyParams
myStatement = [stmt| SELECT baz FROM my_table WHERE foo > ${foo} AND bar = ${bar} |]

Since: 0.0.0

Prepared statements

PreparedStatements can be obtained using withPreparedStatement.

This can be useful when executing a statement repeatedly and you want to save some time on parsing and type-checking the statement on the database server.

data PreparedStatement a

Prepared statement

Since: 0.0.0

Instances

Contravariant PreparedStatement

Since: 0.0.0

Defined in PostgreSQL.Statement

Methods

contramap :: (a -> b) -> PreparedStatement b -> PreparedStatement a

(>$) :: b -> PreparedStatement b -> PreparedStatement a

Executable PreparedStatement

Since: 0.0.0

Defined in PostgreSQL.Query.Class

Methods

execute :: Query query => PreparedStatement param -> param -> query (NativeResult query)

Query execution

Queries are built using any type query that satisfies Query query. The combinators below are used to run or prepare statements.

In most cases you will use runQuery or runQueryThrow to then actually run the query.

ConnectionPoolT is a useful interpreter for the RunQuery effect.

Combinators

execute

Arguments

:: (Executable statement, Query query)

=> statement param

Statement

-> param

Statement input

-> query (NativeResult query)

Execute a statement.

Since: 0.0.0

execute_

Arguments

:: (Executable statement, Query query)

=> statement param

Statement

-> param

Statement input

-> query ()

Like execute but does not concern itself with the result handle.

Since: 0.0.0

query

Arguments

:: (Executable statement, Query query, AutoRow row)

=> statement param

Query statement

-> param

Query parameter

-> query (Vector row)

Perform a parameterized query.

Since: 0.0.0

queryWith

Arguments

:: (Executable statement, Query query)

=> statement param

Query statement

-> param

Query parameter

-> Result row

Result row processor

-> query row

Perform a parameterized query. This also lets you specify the result processor explicitly.

Since: 0.0.0

withPreparedStatement

Arguments

:: Query query

=> Statement a

Statement to prepare

-> (PreparedStatement a -> query r)

Scope within the prepared statement may be used

-> query r

Prepare a statement. The prepared statement is only valid within the provided continuation.

Since: 0.0.0

Evaluation

class Monad query => Query query

PostgreSQL query

Since: 0.0.0

Minimal complete definition

executeStatement, executePreparedStatement, withPreparedStatement, processResult

Instances

(MonadIO m, MonadMask m) => Query (QueryT m)

Defined in PostgreSQL.Query

Associated Types

type NativeResult (QueryT m)

Methods

executeStatement :: Statement a -> a -> QueryT m (NativeResult (QueryT m))

executePreparedStatement :: PreparedStatement a -> a -> QueryT m (NativeResult (QueryT m))

withPreparedStatement :: Statement a -> (PreparedStatement a -> QueryT m r) -> QueryT m r

processResult :: NativeResult (QueryT m) -> Result a -> QueryT m a

class Query query => RunQuery query m | m -> query where

PostgreSQL queries can be executed in m

Since: 0.0.0

Methods

runQuery :: query a -> m (Either Errors a)

Run a query.

Since: 0.0.0

Instances

(RunQuery query m, Monad m, MonadTrans t) => RunQuery query (t m)

Since: 0.0.0

Defined in PostgreSQL.Class

Methods

runQuery :: query a -> t m (Either Errors a)

(MonadMask m, MonadIO m) => RunQuery (QueryT m) (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

runQuery :: QueryT m a -> ConnectionPoolT m (Either Errors a)

runQueryThrow :: (MonadThrow m, RunQuery query m) => query a -> m a

Like runQuery but throws the first error instead.

Since: 0.0.0

Interpreters

data ConnectionPoolT m a

Interpreter for RunQuery which dispatches queries to a pool of database connections

Since: 0.0.0

Instances

MonadTrans ConnectionPoolT

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

lift :: Monad m => m a -> ConnectionPoolT m a

MonadWriter w m => MonadWriter w (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

writer :: (a, w) -> ConnectionPoolT m a

tell :: w -> ConnectionPoolT m ()

listen :: ConnectionPoolT m a -> ConnectionPoolT m (a, w)

pass :: ConnectionPoolT m (a, w -> w) -> ConnectionPoolT m a

MonadState s m => MonadState s (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

get :: ConnectionPoolT m s

put :: s -> ConnectionPoolT m ()

state :: (s -> (a, s)) -> ConnectionPoolT m a

MonadError e m => MonadError e (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

throwError :: e -> ConnectionPoolT m a

catchError :: ConnectionPoolT m a -> (e -> ConnectionPoolT m a) -> ConnectionPoolT m a

Monad m => Monad (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

(>>=) :: ConnectionPoolT m a -> (a -> ConnectionPoolT m b) -> ConnectionPoolT m b

(>>) :: ConnectionPoolT m a -> ConnectionPoolT m b -> ConnectionPoolT m b

return :: a -> ConnectionPoolT m a

Functor m => Functor (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

fmap :: (a -> b) -> ConnectionPoolT m a -> ConnectionPoolT m b

(<$) :: a -> ConnectionPoolT m b -> ConnectionPoolT m a

MonadFail m => MonadFail (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

fail :: String -> ConnectionPoolT m a

Applicative m => Applicative (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

pure :: a -> ConnectionPoolT m a

(<*>) :: ConnectionPoolT m (a -> b) -> ConnectionPoolT m a -> ConnectionPoolT m b

liftA2 :: (a -> b -> c) -> ConnectionPoolT m a -> ConnectionPoolT m b -> ConnectionPoolT m c

(*>) :: ConnectionPoolT m a -> ConnectionPoolT m b -> ConnectionPoolT m b

(<*) :: ConnectionPoolT m a -> ConnectionPoolT m b -> ConnectionPoolT m a

MonadIO m => MonadIO (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

liftIO :: IO a -> ConnectionPoolT m a

MonadThrow m => MonadThrow (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

throwM :: Exception e => e -> ConnectionPoolT m a

MonadCatch m => MonadCatch (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

catch :: Exception e => ConnectionPoolT m a -> (e -> ConnectionPoolT m a) -> ConnectionPoolT m a

MonadMask m => MonadMask (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

mask :: ((forall a. ConnectionPoolT m a -> ConnectionPoolT m a) -> ConnectionPoolT m b) -> ConnectionPoolT m b

uninterruptibleMask :: ((forall a. ConnectionPoolT m a -> ConnectionPoolT m a) -> ConnectionPoolT m b) -> ConnectionPoolT m b

generalBracket :: ConnectionPoolT m a -> (a -> ExitCase b -> ConnectionPoolT m c) -> (a -> ConnectionPoolT m b) -> ConnectionPoolT m (b, c)

MonadConc m => MonadConc (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Associated Types

type STM (ConnectionPoolT m) :: Type -> Type

type MVar (ConnectionPoolT m) :: Type -> Type

type IORef (ConnectionPoolT m) :: Type -> Type

type Ticket (ConnectionPoolT m) :: Type -> Type

type ThreadId (ConnectionPoolT m)

Methods

forkWithUnmask :: ((forall a. ConnectionPoolT m a -> ConnectionPoolT m a) -> ConnectionPoolT m ()) -> ConnectionPoolT m (ThreadId (ConnectionPoolT m))

forkWithUnmaskN :: String -> ((forall a. ConnectionPoolT m a -> ConnectionPoolT m a) -> ConnectionPoolT m ()) -> ConnectionPoolT m (ThreadId (ConnectionPoolT m))

forkOnWithUnmask :: Int -> ((forall a. ConnectionPoolT m a -> ConnectionPoolT m a) -> ConnectionPoolT m ()) -> ConnectionPoolT m (ThreadId (ConnectionPoolT m))

forkOnWithUnmaskN :: String -> Int -> ((forall a. ConnectionPoolT m a -> ConnectionPoolT m a) -> ConnectionPoolT m ()) -> ConnectionPoolT m (ThreadId (ConnectionPoolT m))

forkOSWithUnmask :: ((forall a. ConnectionPoolT m a -> ConnectionPoolT m a) -> ConnectionPoolT m ()) -> ConnectionPoolT m (ThreadId (ConnectionPoolT m))

forkOSWithUnmaskN :: String -> ((forall a. ConnectionPoolT m a -> ConnectionPoolT m a) -> ConnectionPoolT m ()) -> ConnectionPoolT m (ThreadId (ConnectionPoolT m))

supportsBoundThreads :: ConnectionPoolT m Bool

isCurrentThreadBound :: ConnectionPoolT m Bool

getNumCapabilities :: ConnectionPoolT m Int

setNumCapabilities :: Int -> ConnectionPoolT m ()

myThreadId :: ConnectionPoolT m (ThreadId (ConnectionPoolT m))

yield :: ConnectionPoolT m ()

threadDelay :: Int -> ConnectionPoolT m ()

newEmptyMVar :: ConnectionPoolT m (MVar (ConnectionPoolT m) a)

newEmptyMVarN :: String -> ConnectionPoolT m (MVar (ConnectionPoolT m) a)

putMVar :: MVar (ConnectionPoolT m) a -> a -> ConnectionPoolT m ()

tryPutMVar :: MVar (ConnectionPoolT m) a -> a -> ConnectionPoolT m Bool

readMVar :: MVar (ConnectionPoolT m) a -> ConnectionPoolT m a

tryReadMVar :: MVar (ConnectionPoolT m) a -> ConnectionPoolT m (Maybe a)

takeMVar :: MVar (ConnectionPoolT m) a -> ConnectionPoolT m a

tryTakeMVar :: MVar (ConnectionPoolT m) a -> ConnectionPoolT m (Maybe a)

newIORef :: a -> ConnectionPoolT m (IORef (ConnectionPoolT m) a)

newIORefN :: String -> a -> ConnectionPoolT m (IORef (ConnectionPoolT m) a)

readIORef :: IORef (ConnectionPoolT m) a -> ConnectionPoolT m a

atomicModifyIORef :: IORef (ConnectionPoolT m) a -> (a -> (a, b)) -> ConnectionPoolT m b

writeIORef :: IORef (ConnectionPoolT m) a -> a -> ConnectionPoolT m ()

atomicWriteIORef :: IORef (ConnectionPoolT m) a -> a -> ConnectionPoolT m ()

readForCAS :: IORef (ConnectionPoolT m) a -> ConnectionPoolT m (Ticket (ConnectionPoolT m) a)

peekTicket' :: Proxy (ConnectionPoolT m) -> Ticket (ConnectionPoolT m) a -> a

casIORef :: IORef (ConnectionPoolT m) a -> Ticket (ConnectionPoolT m) a -> a -> ConnectionPoolT m (Bool, Ticket (ConnectionPoolT m) a)

modifyIORefCAS :: IORef (ConnectionPoolT m) a -> (a -> (a, b)) -> ConnectionPoolT m b

modifyIORefCAS_ :: IORef (ConnectionPoolT m) a -> (a -> a) -> ConnectionPoolT m ()

atomically :: STM (ConnectionPoolT m) a -> ConnectionPoolT m a

newTVarConc :: a -> ConnectionPoolT m (TVar (STM (ConnectionPoolT m)) a)

readTVarConc :: TVar (STM (ConnectionPoolT m)) a -> ConnectionPoolT m a

throwTo :: Exception e => ThreadId (ConnectionPoolT m) -> e -> ConnectionPoolT m ()

getMaskingState :: ConnectionPoolT m MaskingState

unsafeUnmask :: ConnectionPoolT m a -> ConnectionPoolT m a

(MonadMask m, MonadIO m) => RunQuery (QueryT m) (ConnectionPoolT m)

Since: 0.0.0

Defined in PostgreSQL.ConnectionPool

Methods

runQuery :: QueryT m a -> ConnectionPoolT m (Either Errors a)

type IORef (ConnectionPoolT m)

Defined in PostgreSQL.ConnectionPool

type IORef (ConnectionPoolT m) = IORef (PoolT Connection m)

type MVar (ConnectionPoolT m)

Defined in PostgreSQL.ConnectionPool

type MVar (ConnectionPoolT m) = MVar (PoolT Connection m)

type STM (ConnectionPoolT m)

Defined in PostgreSQL.ConnectionPool

type STM (ConnectionPoolT m) = STM (PoolT Connection m)

type ThreadId (ConnectionPoolT m)

Defined in PostgreSQL.ConnectionPool

type ThreadId (ConnectionPoolT m) = ThreadId (PoolT Connection m)

type Ticket (ConnectionPoolT m)

Defined in PostgreSQL.ConnectionPool

type Ticket (ConnectionPoolT m) = Ticket (PoolT Connection m)

runConnectionPoolT

Arguments

:: (MonadIO m, MonadConc m)

=> m Connection

Action to establish a new connection

-> Settings

Connection pool settings

-> ConnectionPoolT m a

Transformer to run

-> m a

Run connection pool transformer.

Since: 0.0.0

defaultConnectionPoolSettings :: Settings

Default settings for the connection pool

Since: 0.0.0

Result processing

Top level

data Result a

Query result

Since: 0.0.0

Instances

Functor Result

Since: 0.0.0

Defined in PostgreSQL.Result

Methods

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

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

ignored :: Result ()

Ignore the result set.

Since: 0.0.0

single :: Row a -> Result a

Process exactly 1 row.

Since: 0.0.0

first :: Row a -> Result a

Process only the first row. There may be more rows in the result set, but they won't be touched.

Since: 0.0.0

many :: Row a -> Result (Vector a)

Process 0 or more rows.

Since: 0.0.0

affectedRows :: Result Integer

Get the number of affected rows.

Since: 0.0.0

Row level

data Row a

Result row parser

Since: 0.0.0

Instances

Functor Row

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

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

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

Applicative Row

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

pure :: a -> Row a

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

liftA2 :: (a -> b -> c) -> Row a -> Row b -> Row c

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

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

Apply Row

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

(<.>) :: Row (a -> b) -> Row a -> Row b

(.>) :: Row a -> Row b -> Row b

(<.) :: Row a -> Row b -> Row a

liftF2 :: (a -> b -> c) -> Row a -> Row b -> Row c

column :: AutoColumn a => Row a

Floating column using the default Column for a

The position of this column is depenend on other floating columns left of it.

For example:

foo = baz <$> column <*> column <*> column
--            ^ A        ^ B        ^ C

Here, A would be at index 0, B at 1 and C at 2. Other non-floating columns do not impact the column indices.

Since: 0.0.0

columnWith :: Column a -> Row a

Same as column but lets you specify the Column.

Since: 0.0.0

fixedColumn :: AutoColumn a => ColumnNum -> Row a

Fixed-position column using the default Column for a

Since: 0.0.0

fixedColumnWith :: ColumnNum -> Column a -> Row a

Same as fixedColumn but lets you specify the Column.

Since: 0.0.0

namedColumn :: AutoColumn a => ByteString -> Row a

Named column using the default Column for a

Since: 0.0.0

namedColumnWith :: ByteString -> Column a -> Row a

Same as namedColumn but lets you specify the Column.

Since: 0.0.0

class AutoRow a where

Default row parser for a type

Since: 0.0.0

Minimal complete definition

Nothing

Methods

autoRow :: Row a

Default row parser for a

You may omit a definition for autoRow if a implements Generic.

Since: 0.0.0

default autoRow :: (Generic a, AutoRow (Rep a Void)) => Row a

Instances

AutoColumnDelegate a => AutoRow (Identity a)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row (Identity a)

(AutoColumnDelegate a, AutoColumnDelegate b) => AutoRow (a, b)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row (a, b)

(AutoColumnDelegate a, AutoColumnDelegate b, AutoColumnDelegate c) => AutoRow (a, b, c)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row (a, b, c)

AutoColumnDelegate a => AutoRow (K1 tag a x)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row (K1 tag a x)

(AutoRow (lhs x), AutoRow (rhs x)) => AutoRow ((lhs :*: rhs) x)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row ((lhs :*: rhs) x)

(AutoColumnDelegate a, AutoColumnDelegate b, AutoColumnDelegate c, AutoColumnDelegate d) => AutoRow (a, b, c, d)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row (a, b, c, d)

AutoRow (f x) => AutoRow (M1 tag meta f x)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row (M1 tag meta f x)

(AutoColumnDelegate a, AutoColumnDelegate b, AutoColumnDelegate c, AutoColumnDelegate d, AutoColumnDelegate e) => AutoRow (a, b, c, d, e)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row (a, b, c, d, e)

(AutoColumnDelegate a, AutoColumnDelegate b, AutoColumnDelegate c, AutoColumnDelegate d, AutoColumnDelegate e, AutoColumnDelegate f) => AutoRow (a, b, c, d, e, f)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row (a, b, c, d, e, f)

(AutoColumnDelegate a, AutoColumnDelegate b, AutoColumnDelegate c, AutoColumnDelegate d, AutoColumnDelegate e, AutoColumnDelegate f, AutoColumnDelegate g) => AutoRow (a, b, c, d, e, f, g)

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoRow :: Row (a, b, c, d, e, f, g)

class AutoColumnDelegate a

This class is used to intercept instance heads like Fixed and Named that have special additional meaning. For most cases it will delegate to AutoColumn.

Use this class instead of AutoColumn when implementing AutoRow instances.

Since: 0.0.0

Minimal complete definition

autoColumnDelegate

Instances

AutoColumn a => AutoColumnDelegate a

Passthrough to AutoColumn

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoColumnDelegate :: Row a

(KnownSymbol name, AutoColumn a) => AutoColumnDelegate (Named name a)

Uses namedColumn with name to construct the Row

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoColumnDelegate :: Row (Named name a)

(KnownNat index, AutoColumn a) => AutoColumnDelegate (Fixed index a)

Uses fixedColumn with index to construct the Row

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoColumnDelegate :: Row (Fixed index a)

genericRow :: (Generic a, AutoRow (Rep a Void)) => Row a

Generic row parser

You can use this with your Generic-implementing data types.

data Foo = Foo
  { bar :: Integer
  , baz :: Text
  }
  deriving Generic

fooRow :: Row Foo
fooRow = genericRow

Since: 0.0.0

newtype Named (name :: Symbol) a

Value for a named column

Since: 0.0.0

Constructors

Named

Fields

• fromNamed :: a

Instances

(KnownSymbol name, AutoColumn a) => AutoColumnDelegate (Named name a)

Uses namedColumn with name to construct the Row

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoColumnDelegate :: Row (Named name a)

newtype Fixed (index :: Nat) a

Value for a column at a fixed location

Since: 0.0.0

Constructors

Fixed

Fields

• fromFixed :: a

Instances

(KnownNat index, AutoColumn a) => AutoColumnDelegate (Fixed index a)

Uses fixedColumn with index to construct the Row

Since: 0.0.0

Defined in PostgreSQL.Result.Row

Methods

autoColumnDelegate :: Row (Fixed index a)

Column level

data Column a

Result column parser

Since: 0.0.0

Instances

Functor Column

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

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

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

Alt Column

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

(<!>) :: Column a -> Column a -> Column a

some :: Applicative Column => Column a -> Column [a]

many :: Applicative Column => Column a -> Column [a]

class AutoColumn a where

Default column parser for a type

Since: 0.0.0

Methods

autoColumn :: Column a

Default column parser for a

Since: 0.0.0

Instances

AutoColumn Double

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column Double

AutoColumn Float

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column Float

AutoColumn Int

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column Int

AutoColumn Integer

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column Integer

AutoColumn Natural

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column Natural

AutoColumn Word

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column Word

AutoColumn ()

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column ()

AutoColumn Text

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column Text

AutoColumn Oid

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column Oid

AutoColumn RawValue

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column RawValue

Read a => AutoColumn (Readable a)

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column (Readable a)

(AutoColumn a, AutoColumn b) => AutoColumn (Either a b)

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column (Either a b)

newtype Readable a

Provides a AutoColumn instance using the Read for a

Since: 0.0.0

Constructors

Readable a

Instances

Read a => AutoColumn (Readable a)

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column (Readable a)

Errors

data Error

Since: 0.0.0

Constructors

ErrorDuringProcessing ProcessorError

Occurs when processing the result table

ErrorDuringValidation ResultError

Occurs when validating the result object

Instances

Eq Error

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

(==) :: Error -> Error -> Bool

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

Ord Error

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

compare :: Error -> Error -> Ordering

(<) :: Error -> Error -> Bool

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

(>) :: Error -> Error -> Bool

(>=) :: Error -> Error -> Bool

max :: Error -> Error -> Error

min :: Error -> Error -> Error

Show Error

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

Exception Error

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

toException :: Error -> SomeException

fromException :: SomeException -> Maybe Error

displayException :: Error -> String

Monad m => MonadError Errors (QueryT m)

Since: 0.0.0

Defined in PostgreSQL.Query

Methods

throwError :: Errors -> QueryT m a

catchError :: QueryT m a -> (Errors -> QueryT m a) -> QueryT m a

type Errors = NonEmpty Error

data ProcessorError

Error that may occur during processing

Since: 0.0.0

Constructors

ColumnParserError

Fields

• processorError_column :: ColumnNum
• processorError_type :: Oid
• processorError_format :: Format
• processorError_columnError :: ParserError

CellParserError

Fields

• processorError_column :: ColumnNum
• processorError_type :: Oid
• processorError_format :: Format
• processorError_row :: RowNum
• processorError_value :: Value
• processorError_cellError :: Text

NotEnoughColumns

Fields

• processorError_wantedColumns :: ColumnNum
• processorError_haveColumns :: ColumnNum

MissingNamedColumn

Fields

• processorError_wantedColumnName :: ByteString

Instances

Eq ProcessorError

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

(==) :: ProcessorError -> ProcessorError -> Bool

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

Ord ProcessorError

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

compare :: ProcessorError -> ProcessorError -> Ordering

(<) :: ProcessorError -> ProcessorError -> Bool

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

(>) :: ProcessorError -> ProcessorError -> Bool

(>=) :: ProcessorError -> ProcessorError -> Bool

max :: ProcessorError -> ProcessorError -> ProcessorError

min :: ProcessorError -> ProcessorError -> ProcessorError

Show ProcessorError

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

showsPrec :: Int -> ProcessorError -> ShowS

show :: ProcessorError -> String

showList :: [ProcessorError] -> ShowS

type ProcessorErrors = NonEmpty ProcessorError

data ResultError

Error that occurs when validating the result

Since: 0.0.0

Constructors

BadResultStatus

Fields

• resultError_status :: ByteString

NoRows

MultipleRows

Fields

• resultError_numRows :: RowNum

FailedToParseAffectedRows

Fields

• resultError_message :: Text

Instances

Eq ResultError

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

(==) :: ResultError -> ResultError -> Bool

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

Ord ResultError

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

compare :: ResultError -> ResultError -> Ordering

(<) :: ResultError -> ResultError -> Bool

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

(>) :: ResultError -> ResultError -> Bool

(>=) :: ResultError -> ResultError -> Bool

max :: ResultError -> ResultError -> ResultError

min :: ResultError -> ResultError -> ResultError

Show ResultError

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

showsPrec :: Int -> ResultError -> ShowS

show :: ResultError -> String

showList :: [ResultError] -> ShowS

type ResultErrors = NonEmpty ResultError

data ParserError

Error that occurs when parsing a column

Since: 0.0.0

Constructors

UnsupportedFormat Format

UnsupportedOid Oid

Instances

Eq ParserError

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

(==) :: ParserError -> ParserError -> Bool

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

Ord ParserError

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

compare :: ParserError -> ParserError -> Ordering

(<) :: ParserError -> ParserError -> Bool

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

(>) :: ParserError -> ParserError -> Bool

(>=) :: ParserError -> ParserError -> Bool

max :: ParserError -> ParserError -> ParserError

min :: ParserError -> ParserError -> ParserError

Show ParserError

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

showsPrec :: Int -> ParserError -> ShowS

show :: ParserError -> String

showList :: [ParserError] -> ShowS

type ParserErrors = NonEmpty ParserError

Common types

data Format

Constructors

Text

Binary

Instances

Enum Format

Defined in Database.PostgreSQL.LibPQ

Methods

succ :: Format -> Format

pred :: Format -> Format

toEnum :: Int -> Format

fromEnum :: Format -> Int

enumFrom :: Format -> [Format]

enumFromThen :: Format -> Format -> [Format]

enumFromTo :: Format -> Format -> [Format]

enumFromThenTo :: Format -> Format -> Format -> [Format]

Eq Format

Defined in Database.PostgreSQL.LibPQ

Methods

(==) :: Format -> Format -> Bool

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

Ord Format

Defined in Database.PostgreSQL.LibPQ

Methods

compare :: Format -> Format -> Ordering

(<) :: Format -> Format -> Bool

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

(>) :: Format -> Format -> Bool

(>=) :: Format -> Format -> Bool

max :: Format -> Format -> Format

min :: Format -> Format -> Format

Show Format

Defined in Database.PostgreSQL.LibPQ

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

data Oid

Instances

Eq Oid

Defined in Database.PostgreSQL.LibPQ

Methods

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

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

Ord Oid

Defined in Database.PostgreSQL.LibPQ

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

Defined in Database.PostgreSQL.LibPQ

Methods

readsPrec :: Int -> ReadS Oid

readList :: ReadS [Oid]

readPrec :: ReadPrec Oid

readListPrec :: ReadPrec [Oid]

Show Oid

Defined in Database.PostgreSQL.LibPQ

Methods

showsPrec :: Int -> Oid -> ShowS

show :: Oid -> String

showList :: [Oid] -> ShowS

Storable Oid

Defined in Database.PostgreSQL.LibPQ

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 ()

AutoColumn Oid

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column Oid

Param Oid

Since: 0.0.0

Defined in PostgreSQL.Param

Methods

paramInfo :: Info (Oid -> Value)

data ColumnNum

Numberic column identifier

Since: 0.0.0

Instances

Bounded ColumnNum

Defined in PostgreSQL.Types

Methods

minBound :: ColumnNum

maxBound :: ColumnNum

Enum ColumnNum

Defined in PostgreSQL.Types

Methods

succ :: ColumnNum -> ColumnNum

pred :: ColumnNum -> ColumnNum

toEnum :: Int -> ColumnNum

fromEnum :: ColumnNum -> Int

enumFrom :: ColumnNum -> [ColumnNum]

enumFromThen :: ColumnNum -> ColumnNum -> [ColumnNum]

enumFromTo :: ColumnNum -> ColumnNum -> [ColumnNum]

enumFromThenTo :: ColumnNum -> ColumnNum -> ColumnNum -> [ColumnNum]

Eq ColumnNum

Defined in PostgreSQL.Types

Methods

(==) :: ColumnNum -> ColumnNum -> Bool

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

Integral ColumnNum

Defined in PostgreSQL.Types

Methods

quot :: ColumnNum -> ColumnNum -> ColumnNum

rem :: ColumnNum -> ColumnNum -> ColumnNum

div :: ColumnNum -> ColumnNum -> ColumnNum

mod :: ColumnNum -> ColumnNum -> ColumnNum

quotRem :: ColumnNum -> ColumnNum -> (ColumnNum, ColumnNum)

divMod :: ColumnNum -> ColumnNum -> (ColumnNum, ColumnNum)

toInteger :: ColumnNum -> Integer

Num ColumnNum

Defined in PostgreSQL.Types

Methods

(+) :: ColumnNum -> ColumnNum -> ColumnNum

(-) :: ColumnNum -> ColumnNum -> ColumnNum

(*) :: ColumnNum -> ColumnNum -> ColumnNum

negate :: ColumnNum -> ColumnNum

abs :: ColumnNum -> ColumnNum

signum :: ColumnNum -> ColumnNum

fromInteger :: Integer -> ColumnNum

Ord ColumnNum

Defined in PostgreSQL.Types

Methods

compare :: ColumnNum -> ColumnNum -> Ordering

(<) :: ColumnNum -> ColumnNum -> Bool

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

(>) :: ColumnNum -> ColumnNum -> Bool

(>=) :: ColumnNum -> ColumnNum -> Bool

max :: ColumnNum -> ColumnNum -> ColumnNum

min :: ColumnNum -> ColumnNum -> ColumnNum

Read ColumnNum

Defined in PostgreSQL.Types

Methods

readsPrec :: Int -> ReadS ColumnNum

readList :: ReadS [ColumnNum]

readPrec :: ReadPrec ColumnNum

readListPrec :: ReadPrec [ColumnNum]

Real ColumnNum

Defined in PostgreSQL.Types

Methods

toRational :: ColumnNum -> Rational

Show ColumnNum

Defined in PostgreSQL.Types

Methods

showsPrec :: Int -> ColumnNum -> ShowS

show :: ColumnNum -> String

showList :: [ColumnNum] -> ShowS

data RowNum

Numberic row identifier

Since: 0.0.0

Instances

Bounded RowNum

Defined in PostgreSQL.Types

Methods

minBound :: RowNum

maxBound :: RowNum

Enum RowNum

Defined in PostgreSQL.Types

Methods

succ :: RowNum -> RowNum

pred :: RowNum -> RowNum

toEnum :: Int -> RowNum

fromEnum :: RowNum -> Int

enumFrom :: RowNum -> [RowNum]

enumFromThen :: RowNum -> RowNum -> [RowNum]

enumFromTo :: RowNum -> RowNum -> [RowNum]

enumFromThenTo :: RowNum -> RowNum -> RowNum -> [RowNum]

Eq RowNum

Defined in PostgreSQL.Types

Methods

(==) :: RowNum -> RowNum -> Bool

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

Integral RowNum

Defined in PostgreSQL.Types

Methods

quot :: RowNum -> RowNum -> RowNum

rem :: RowNum -> RowNum -> RowNum

div :: RowNum -> RowNum -> RowNum

mod :: RowNum -> RowNum -> RowNum

quotRem :: RowNum -> RowNum -> (RowNum, RowNum)

divMod :: RowNum -> RowNum -> (RowNum, RowNum)

toInteger :: RowNum -> Integer

Num RowNum

Defined in PostgreSQL.Types

Methods

(+) :: RowNum -> RowNum -> RowNum

(-) :: RowNum -> RowNum -> RowNum

(*) :: RowNum -> RowNum -> RowNum

negate :: RowNum -> RowNum

abs :: RowNum -> RowNum

signum :: RowNum -> RowNum

fromInteger :: Integer -> RowNum

Ord RowNum

Defined in PostgreSQL.Types

Methods

compare :: RowNum -> RowNum -> Ordering

(<) :: RowNum -> RowNum -> Bool

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

(>) :: RowNum -> RowNum -> Bool

(>=) :: RowNum -> RowNum -> Bool

max :: RowNum -> RowNum -> RowNum

min :: RowNum -> RowNum -> RowNum

Read RowNum

Defined in PostgreSQL.Types

Methods

readsPrec :: Int -> ReadS RowNum

readList :: ReadS [RowNum]

readPrec :: ReadPrec RowNum

readListPrec :: ReadPrec [RowNum]

Real RowNum

Defined in PostgreSQL.Types

Methods

toRational :: RowNum -> Rational

Show RowNum

Defined in PostgreSQL.Types

Methods

showsPrec :: Int -> RowNum -> ShowS

show :: RowNum -> String

showList :: [RowNum] -> ShowS

data Value

Value

Since: 0.0.0

Constructors

Null

Value ByteString

Instances

Eq Value

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

(==) :: Value -> Value -> Bool

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

Ord Value

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

compare :: Value -> Value -> Ordering

(<) :: Value -> Value -> Bool

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

(>) :: Value -> Value -> Bool

(>=) :: Value -> Value -> Bool

max :: Value -> Value -> Value

min :: Value -> Value -> Value

Show Value

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

IsString Value

Since: 0.0.0

Defined in PostgreSQL.Types

Methods

fromString :: String -> Value

Param Value

Since: 0.0.0

Defined in PostgreSQL.Param

Methods

paramInfo :: Info (Value -> Value)

data RawValue

The raw cell value

Since: 0.0.0

Constructors

RawValue

Fields

• rawValue_type :: Oid
• rawValue_format :: Format
• rawValue_value :: Value

Instances

Eq RawValue

Defined in PostgreSQL.Result.Column

Methods

(==) :: RawValue -> RawValue -> Bool

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

Ord RawValue

Defined in PostgreSQL.Result.Column

Methods

compare :: RawValue -> RawValue -> Ordering

(<) :: RawValue -> RawValue -> Bool

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

(>) :: RawValue -> RawValue -> Bool

(>=) :: RawValue -> RawValue -> Bool

max :: RawValue -> RawValue -> RawValue

min :: RawValue -> RawValue -> RawValue

Show RawValue

Defined in PostgreSQL.Result.Column

Methods

showsPrec :: Int -> RawValue -> ShowS

show :: RawValue -> String

showList :: [RawValue] -> ShowS

AutoColumn RawValue

Since: 0.0.0

Defined in PostgreSQL.Result.Column

Methods

autoColumn :: Column RawValue