Hasql.Decoders

A DSL for declaration of result decoders.

Result

data Result a

Decoder of a query result.

Instances

Functor Result

Defined in Hasql.Decoders.All

Methods

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

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

noResult :: Result ()

Decode no value from the result.

Useful for statements like INSERT or CREATE.

rowsAffected :: Result Int64

Get the amount of rows affected by such statements as UPDATE or DELETE.

singleRow :: Row a -> Result a

Exactly one row. Will raise the UnexpectedAmountOfRows error if it's any other.

Specialized multi-row results

rowMaybe :: Row a -> Result (Maybe a)

Maybe one row or none.

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

Zero or more rows packed into the vector.

It's recommended to prefer this function to rowList, since it performs notably better.

rowList :: Row a -> Result [a]

Zero or more rows packed into the list.

Multi-row traversers

foldlRows :: (a -> b -> a) -> a -> Row b -> Result a

Foldl multiple rows.

foldrRows :: (b -> a -> a) -> a -> Row b -> Result a

Foldr multiple rows.

Row

data Row a

Decoder of an individual row, which gets composed of column value decoders.

E.g.:

x :: Row (Maybe Int64, Text, TimeOfDay)
x = (,,) <$> (column . nullable) int8 <*> (column . nonNullable) text <*> (column . nonNullable) time

Instances

MonadFail Row

Defined in Hasql.Decoders.All

Methods

fail :: String -> Row a

Applicative Row

Defined in Hasql.Decoders.All

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

Functor Row

Defined in Hasql.Decoders.All

Methods

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

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

Monad Row

Defined in Hasql.Decoders.All

Methods

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

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

return :: a -> Row a

column :: NullableOrNot Value a -> Row a

Lift an individual value decoder to a composable row decoder.

Nullability

data NullableOrNot decoder a

Extensional specification of nullability over a generic decoder.

nonNullable :: decoder a -> NullableOrNot decoder a

Specify that a decoder produces a non-nullable value.

nullable :: decoder a -> NullableOrNot decoder (Maybe a)

Specify that a decoder produces a nullable value.

Value

data Value a

Decoder of a value.

Instances

Functor Value

Defined in Hasql.Decoders.All

Methods

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

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

bool :: Value Bool

Decoder of the BOOL values.

int2 :: Value Int16

Decoder of the INT2 values.

int4 :: Value Int32

Decoder of the INT4 values.

int8 :: Value Int64

Decoder of the INT8 values.

float4 :: Value Float

Decoder of the FLOAT4 values.

float8 :: Value Double

Decoder of the FLOAT8 values.

numeric :: Value Scientific

Decoder of the NUMERIC values.

char :: Value Char

Decoder of the CHAR values. Note that it supports Unicode values.

text :: Value Text

Decoder of the TEXT values.

bytea :: Value ByteString

Decoder of the BYTEA values.

date :: Value Day

Decoder of the DATE values.

timestamp :: Value LocalTime

Decoder of the TIMESTAMP values.

timestamptz :: Value UTCTime

Decoder of the TIMESTAMPTZ values.

NOTICE

Postgres does not store the timezone information of TIMESTAMPTZ. Instead it stores a UTC value and performs silent conversions to the currently set timezone, when dealt with in the text format. However this library bypasses the silent conversions and communicates with Postgres using the UTC values directly.

time :: Value TimeOfDay

Decoder of the TIME values.

timetz :: Value (TimeOfDay, TimeZone)

Decoder of the TIMETZ values.

Unlike in case of TIMESTAMPTZ, Postgres does store the timezone information for TIMETZ. However the Haskell's "time" library does not contain any composite type, that fits the task, so we use a pair of TimeOfDay and TimeZone to represent a value on the Haskell's side.

interval :: Value DiffTime

Decoder of the INTERVAL values.

uuid :: Value UUID

Decoder of the UUID values.

inet :: Value (NetAddr IP)

Decoder of the INET values.

json :: Value Value

Decoder of the JSON values into a JSON AST.

jsonBytes :: (ByteString -> Either Text a) -> Value a

Decoder of the JSON values into a raw JSON ByteString.

jsonb :: Value Value

Decoder of the JSONB values into a JSON AST.

jsonbBytes :: (ByteString -> Either Text a) -> Value a

Decoder of the JSONB values into a raw JSON ByteString.

array :: Array a -> Value a

Lift an Array decoder to a Value decoder.

listArray :: NullableOrNot Value element -> Value [element]

Lift a value decoder of element into a unidimensional array decoder producing a list.

This function is merely a shortcut to the following expression:

(array . dimension Control.Monad.replicateM . element)

Please notice that in case of multidimensional arrays nesting listArray decoder won't work. You have to explicitly construct the array decoder using array.

vectorArray :: Vector vector element => NullableOrNot Value element -> Value (vector element)

Lift a value decoder of element into a unidimensional array decoder producing a generic vector.

This function is merely a shortcut to the following expression:

(array . dimension Data.Vector.Generic.replicateM . element)

Please notice that in case of multidimensional arrays nesting vectorArray decoder won't work. You have to explicitly construct the array decoder using array.

composite :: Composite a -> Value a

Lift a Composite decoder to a Value decoder.

hstore :: (forall m. Monad m => Int -> m (Text, Maybe Text) -> m a) -> Value a

A generic decoder of HSTORE values.

Here's how you can use it to construct a specific value:

x :: Value [(Text, Maybe Text)]
x = hstore replicateM

enum :: (Text -> Maybe a) -> Value a

Given a partial mapping from text to value, produces a decoder of that value.

custom :: (Bool -> ByteString -> Either Text a) -> Value a

Lift a custom value decoder function to a Value decoder.

refine :: (a -> Either Text b) -> Value a -> Value b

Refine a value decoder, lifting the possible error to the session level.

Array

data Array a

A generic array decoder.

Here's how you can use it to produce a specific array value decoder:

x :: Value [[Text]]
x = array (dimension replicateM (dimension replicateM (element (nonNullable text))))

Instances

Functor Array

Defined in Hasql.Decoders.All

Methods

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

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

dimension :: (forall m. Monad m => Int -> m a -> m b) -> Array a -> Array b

A function for parsing a dimension of an array. Provides support for multi-dimensional arrays.

Accepts:

• An implementation of the replicateM function (Control.Monad.replicateM, Data.Vector.replicateM), which determines the output value.
• A decoder of its components, which can be either another dimension or element.

element :: NullableOrNot Value a -> Array a

Lift a Value decoder into an Array decoder for parsing of leaf values.

Composite

data Composite a

Composable decoder of composite values (rows, records).

Instances

MonadFail Composite

Defined in Hasql.Decoders.All

Methods

fail :: String -> Composite a

Applicative Composite

Defined in Hasql.Decoders.All

Methods

pure :: a -> Composite a

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

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

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

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

Functor Composite

Defined in Hasql.Decoders.All

Methods

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

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

Monad Composite

Defined in Hasql.Decoders.All

Methods

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

(>>) :: Composite a -> Composite b -> Composite b

return :: a -> Composite a

field :: NullableOrNot Value a -> Composite a

Lift a Value decoder into a Composite decoder for parsing of component values.