PostgreSQL.Binary.Decoding · postgresql-binary-0.15.0.1

valuevalueParser :: Value a -> ByteString -> Either Text a

#

typetype Value = BinaryParser

#

Primitive

6 declarations

valueint :: (Integral a, Bits a) => Value a

#

valuefloat4 :: Value Float

#

valuefloat8 :: Value Double

#

valuebool :: Value Bool

#

valuebytea_strict :: Value ByteString

#

BYTEA or any other type in its undecoded form.

valuebytea_lazy :: Value LazyByteString

#

BYTEA or any other type in its undecoded form.

Textual

3 declarations

valuetext_strict :: Value Text

#

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

valuetext_lazy :: Value LazyText

#

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

valuechar :: Value Char

#

A UTF-8-decoded char.

Misc

9 declarations

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

#

Lifts a custom decoder implementation.

valuenumeric :: Value Scientific

#

valueuuid :: Value UUID

#

valueinet :: Value IPRange

#

valuemacaddr :: Value (Word8, Word8, Word8, Word8, Word8, Word8)

#

valuejson_ast :: Value Value

#

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

#

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

valuejsonb_ast :: Value Value

#

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

#

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

11 declarations

valuedate :: Value Day

#

DATE values decoding.

valuetime_int :: Value TimeOfDay

#

TIME values decoding for servers, which have integer_datetimes enabled.

valuetime_float :: Value TimeOfDay

#

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

valuetimetz_int :: Value (TimeOfDay, TimeZone)

#

TIMETZ values decoding for servers, which have integer_datetimes enabled.

valuetimetz_float :: Value (TimeOfDay, TimeZone)

#

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

valuetimestamp_int :: Value LocalTime

#

TIMESTAMP values decoding for servers, which have integer_datetimes enabled.

valuetimestamp_float :: Value LocalTime

#

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

valuetimestamptz_int :: Value UTCTime

#

TIMESTAMP values decoding for servers, which have integer_datetimes enabled.

valuetimestamptz_float :: Value UTCTime

#

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

valueinterval_int :: Value DiffTime

#

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

valueinterval_float :: Value DiffTime

#

INTERVAL values decoding for servers, which have integer_datetimes enabled.

Exotic

0 declarations

Array

newtypenewtype Array a

#

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 :: Value [ [ Text ] ]
x =
  array (dimensionArray replicateM (fmap catMaybes (dimensionArray replicateM (nullableValueArray text))))

Instances1Functor

Functor ArrayDefined in postgresql-binary-0.15.0.1 · PostgreSQL.Binary.Decoding

valuearray :: Array a -> Value a

#

Unlift an Array to a value Value.

valuevalueArray :: Value a -> Array a

#

Lift a value Value into Array for parsing of non-nullable leaf values.

valuenullableValueArray :: Value a -> Array (Maybe a)

#

Lift a value Value into Array for parsing of nullable leaf values.

valuedimensionArray

:: forall (m :: Type -> Type). 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 dimensionArray or nullableValueArray.

Composite

datadata Composite a

#

Instances2Functor, Applicative

Functor CompositeDefined in postgresql-binary-0.15.0.1 · PostgreSQL.Binary.Decoding
Applicative CompositeDefined in postgresql-binary-0.15.0.1 · PostgreSQL.Binary.Decoding

valuecomposite :: Composite a -> Value a

#

Unlift a Composite to a value Value.

valuevalueComposite :: Value a -> Composite a

#

Lift a non-nullable value Value into Composite.

valuenullableValueComposite :: Value a -> Composite (Maybe a)

#

Nullable composite field.

valuetypedValueComposite

:: Word32
Expected type OID.
-> Value a
-> Composite a

#

Non-nullable composite field with a checked type OID.

valuetypedNullableValueComposite

:: Word32
Expected type OID.
-> Value a
-> Composite (Maybe a)

#

Nullable composite field with a checked type OID.

HStore

valuehstore

:: forall (m :: Type -> Type). Monad m => Int -> m (k, Maybe v) -> m r
-> Value k
-> Value v
-> Value r

#

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

Accepts:

An implementation of the replicateM function (Control.Monad.replicateM, Data.Vector.replicateM), which determines how to produce the final datastructure from the rows.
A decoder for keys.
A decoder for values.

Here's how you can use it to produce a parser to list:

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

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

#

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

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

#

Given additional constraints when using an existing value decoder, produces a decoder of that value.

Range

valueint4range :: Value (Range Int32)

#

int4range

valueint8range :: Value (Range Int64)

#

int8range

valuenumrange :: Value (Range Scientific)

#

numrange

valuetsrange_int :: Value (Range LocalTime)

#

tsrange

valuetsrange_float :: Value (Range LocalTime)

#

tsrange

valuetstzrange_int :: Value (Range UTCTime)

#

tstzrange

valuetstzrange_float :: Value (Range UTCTime)

#

tstzrange

valuedaterange :: Value (Range Day)

#

daterange

Multirange

valueint4multirange :: Value (Multirange Int32)

#

int4multirange

valueint8multirange :: Value (Multirange Int64)

#

int8multirange

valuenummultirange :: Value (Multirange Scientific)

#

nummultirange

valuetsmultirange_int :: Value (Multirange LocalTime)

#

tsmultirange

valuetsmultirange_float :: Value (Multirange LocalTime)

#

tsmultirange

valuetstzmultirange_int :: Value (Multirange UTCTime)

#

tstzmultirange

valuetstzmultirange_float :: Value (Multirange UTCTime)

#

tstzmultirange

valuedatemultirange :: Value (Multirange Day)

#

datemultirange