Safe Haskell	None
Language	Haskell2010

PostgreSQL.Binary.Decoder

Contents

Synopsis

typeDecoder =BinaryParser
run ::BinaryParser a ->ByteString ->Either Text a
int :: (Integral a,Bits a) =>Decoder a
float4 ::Decoder Float
float8 ::Decoder Double
bool ::Decoder Bool
bytea_strict ::Decoder ByteString
bytea_lazy ::Decoder LazyByteString
text_strict ::Decoder Text
text_lazy ::Decoder LazyText
char ::Decoder Char
fn :: (ByteString ->Either Text a) ->Decoder a
numeric ::Decoder Scientific
uuid ::Decoder UUID
json_ast ::Decoder Value
json_bytes :: (ByteString ->Either Text a) ->Decoder a
jsonb_ast ::Decoder Value
jsonb_bytes :: (ByteString ->Either Text a) ->Decoder a
date ::Decoder Day
time_int ::Decoder TimeOfDay
time_float ::Decoder TimeOfDay
timetz_int ::Decoder (TimeOfDay,TimeZone)
timetz_float ::Decoder (TimeOfDay,TimeZone)
timestamp_int ::Decoder LocalTime
timestamp_float ::Decoder LocalTime
timestamptz_int ::Decoder UTCTime
timestamptz_float ::Decoder UTCTime
interval_int ::Decoder DiffTime
interval_float ::Decoder DiffTime
dataArrayDecoder a
array ::ArrayDecoder a ->Decoder a
arrayDimension :: (forall m.Monad m =>Int -> m a -> m b) ->ArrayDecoder a ->ArrayDecoder b
arrayValue ::Decoder a ->ArrayDecoder (Maybe a)
arrayNonNullValue ::Decoder a ->ArrayDecoder a
dataCompositeDecoder a
composite ::CompositeDecoder a ->Decoder a
compositeValue ::Decoder a ->CompositeDecoder (Maybe a)
compositeNonNullValue ::Decoder a ->CompositeDecoder a
hstore :: (forall m.Monad m =>Int -> m (k,Maybe v) -> m r) ->Decoder k ->Decoder v ->Decoder r
enum :: (Text ->Maybe a) ->Decoder a

Documentation

typeDecoder =BinaryParser Source

run ::BinaryParser a ->ByteString ->Either Text a

Apply a parser to bytes.

Primitive

int :: (Integral a,Bits a) =>Decoder aSource

float4 ::Decoder Float Source

float8 ::Decoder Double Source

bool ::Decoder Bool Source

bytea_strict ::Decoder ByteString Source

BYTEA or any other type in its undecoded form.

bytea_lazy ::Decoder LazyByteStringSource

BYTEA or any other type in its undecoded form.

Textual

text_strict ::Decoder Text Source

Any of the variable-length character types: BPCHAR, VARCHAR, NAME and TEXT.

text_lazy ::Decoder LazyTextSource

Any of the variable-length character types: BPCHAR, VARCHAR, NAME and TEXT.

char ::Decoder Char Source

A UTF-8-decoded char.

Misc

fn :: (ByteString ->Either Text a) ->Decoder aSource

Lifts a custom decoder implementation.

numeric ::Decoder Scientific Source

uuid ::Decoder UUID Source

json_ast ::Decoder Value Source

json_bytes :: (ByteString ->Either Text a) ->Decoder aSource

Given a function, which parses a plain UTF-8 JSON string encoded as a byte-array, produces a decoder.

jsonb_ast ::Decoder Value Source

jsonb_bytes :: (ByteString ->Either Text a) ->Decoder aSource

Given a function, which parses a plain UTF-8 JSON string encoded as a byte-array, produces a decoder.

For those wondering, yes, JSONB is encoded as plain JSON string in the binary format of Postgres. Sad, but true.

Time

date ::Decoder Day Source

DATE values decoding.

time_int ::Decoder TimeOfDay Source

TIME values decoding for servers, which haveinteger_datetimes enabled.

time_float ::Decoder TimeOfDay Source

TIME values decoding for servers, which don't haveinteger_datetimes enabled.

timetz_int ::Decoder (TimeOfDay,TimeZone)Source

TIMETZ values decoding for servers, which haveinteger_datetimes enabled.

timetz_float ::Decoder (TimeOfDay,TimeZone)Source

TIMETZ values decoding for servers, which don't haveinteger_datetimes enabled.

timestamp_int ::Decoder LocalTime Source

TIMESTAMP values decoding for servers, which haveinteger_datetimes enabled.

timestamp_float ::Decoder LocalTime Source

TIMESTAMP values decoding for servers, which don't haveinteger_datetimes enabled.

timestamptz_int ::Decoder UTCTime Source

TIMESTAMP values decoding for servers, which haveinteger_datetimes enabled.

timestamptz_float ::Decoder UTCTime Source

TIMESTAMP values decoding for servers, which don't haveinteger_datetimes enabled.

interval_int ::Decoder DiffTime Source

INTERVAL values decoding for servers, which don't haveinteger_datetimes enabled.

interval_float ::Decoder DiffTime Source

INTERVAL values decoding for servers, which haveinteger_datetimes enabled.

Exotic

Array

dataArrayDecoder aSource

An efficient generic array decoder, which constructs the result value in place while parsing.

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

x :: Decoder [ [ Text ] ]x =  array (arrayDimension replicateM (fmap catMaybes (arrayDimension replicateM (arrayValue text))))

Instances

Functor ArrayDecoderSource

array ::ArrayDecoder a ->Decoder aSource

Unlift anArrayDecoder to a valueDecoder.

arrayDimension :: (forall m.Monad m =>Int -> m a -> m b) ->ArrayDecoder a ->ArrayDecoder bSource

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

Accepts:

An implementation of thereplicateM function (Control.Monad.replicateM,Data.Vector.replicateM), which determines the output value.
A decoder of its components, which can be either anotherarrayDimension orarrayValue.

arrayValue ::Decoder a ->ArrayDecoder (Maybe a)Source

Lift a valueDecoder intoArrayDecoder for parsing of nullable leaf values.

arrayNonNullValue ::Decoder a ->ArrayDecoder aSource

Lift a valueDecoder intoArrayDecoder for parsing of non-nullable leaf values.

Composite

dataCompositeDecoder aSource

Instances

Monad CompositeDecoderSource
Functor CompositeDecoderSource
Applicative CompositeDecoderSource

composite ::CompositeDecoder a ->Decoder aSource

Unlift aCompositeDecoder to a valueDecoder.

compositeValue ::Decoder a ->CompositeDecoder (Maybe a)Source

Lift a valueDecoder intoCompositeDecoder.

compositeNonNullValue ::Decoder a ->CompositeDecoder aSource

Lift a non-nullable valueDecoder intoCompositeDecoder.

HStore

hstore :: (forall m.Monad m =>Int -> m (k,Maybe v) -> m r) ->Decoder k ->Decoder v ->Decoder rSource

A function for generic in place parsing of an HStore value.