Hasql.Encoders

A DSL for declaration of statement parameter encoders.

For compactness of names all the types defined here imply being an encoder. E.g., the Array type is an encoder of arrays, not the data-structure itself.

Parameters product

data Params a

Encoder of some representation of a parameters product.

Has instances of Contravariant, Divisible and Monoid, which you can use to compose multiple parameters together. E.g.,

someParamsEncoder :: Params (Int64, Maybe Text)
someParamsEncoder =
  (fst >$< param (nonNullable int8)) <>
  (snd >$< param (nullable text))

As a general solution for tuples of any arity, instead of fst and snd, consider the functions of the contrazip family from the "contravariant-extras" package. E.g., here's how you can achieve the same as the above:

someParamsEncoder :: Params (Int64, Maybe Text)
someParamsEncoder =
  contrazip2 (param (nonNullable int8)) (param (nullable text))

Here's how you can implement encoders for custom composite types:

data Person = Person { name :: Text, gender :: Gender, age :: Int }

data Gender = Male | Female

personParams :: Params Person
personParams =
  (name >$< param (nonNullable text)) <>
  (gender >$< param (nonNullable genderValue)) <>
  (fromIntegral . age >$< param (nonNullable int8))

genderValue :: Value Gender
genderValue = enum genderText text where
  genderText gender = case gender of
    Male -> "male"
    Female -> "female"

Instances

Contravariant Params

Defined in Hasql.Encoders.All

Methods

contramap :: (a' -> a) -> Params a -> Params a'

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

Divisible Params

Defined in Hasql.Encoders.All

Methods

divide :: (a -> (b, c)) -> Params b -> Params c -> Params a

conquer :: Params a

Monoid (Params a)

Defined in Hasql.Encoders.All

Methods

mempty :: Params a

mappend :: Params a -> Params a -> Params a

mconcat :: [Params a] -> Params a

Semigroup (Params a)

Defined in Hasql.Encoders.All

Methods

(<>) :: Params a -> Params a -> Params a

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

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

noParams :: Params ()

No parameters. Same as mempty and conquered.

param :: NullableOrNot Value a -> Params a

Lift a single parameter encoder, with its nullability specified, associating it with a single placeholder.

Nullability

data NullableOrNot (encoder :: Type -> Type) a

Extensional specification of nullability over a generic encoder.

nonNullable :: encoder a -> NullableOrNot encoder a

Specify that an encoder produces a non-nullable value.

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

Specify that an encoder produces a nullable value.

Value

data Value a

Value encoder.

Instances

Contravariant Value

Defined in Hasql.Encoders.All

Methods

contramap :: (a' -> a) -> Value a -> Value a'

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

bool :: Value Bool

Encoder of BOOL values.

int2 :: Value Int16

Encoder of INT2 values.

int4 :: Value Int32

Encoder of INT4 values.

int8 :: Value Int64

Encoder of INT8 values.

float4 :: Value Float

Encoder of FLOAT4 values.

float8 :: Value Double

Encoder of FLOAT8 values.

numeric :: Value Scientific

Encoder of NUMERIC values.

char :: Value Char

Encoder of CHAR values.

Note that it supports Unicode values and identifies itself under the TEXT OID because of that.

text :: Value Text

Encoder of TEXT values.

bytea :: Value ByteString

Encoder of BYTEA values.

date :: Value Day

Encoder of DATE values.

timestamp :: Value LocalTime

Encoder of TIMESTAMP values.

timestamptz :: Value UTCTime

Encoder of TIMESTAMPTZ values.

time :: Value TimeOfDay

Encoder of TIME values.

timetz :: Value (TimeOfDay, TimeZone)

Encoder of TIMETZ values.

interval :: Value DiffTime

Encoder of INTERVAL values.

uuid :: Value UUID

Encoder of UUID values.

inet :: Value IPRange

Encoder of INET values.

json :: Value Value

Encoder of JSON values from JSON AST.

jsonBytes :: Value ByteString

Encoder of JSON values from raw JSON.

jsonLazyBytes :: Value ByteString

Encoder of JSON values from raw JSON as lazy ByteString.

jsonb :: Value Value

Encoder of JSONB values from JSON AST.

jsonbBytes :: Value ByteString

Encoder of JSONB values from raw JSON.

jsonbLazyBytes :: Value ByteString

Encoder of JSONB values from raw JSON as lazy ByteString.

name :: Value Text

Encoder of NAME values.

oid :: Value Int32

Encoder of OID values.

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

Given a function, which maps a value into a textual enum label used on the DB side, produces an encoder of that value.

unknownEnum :: (a -> Text) -> Value a

Variation of enum with unknown OID. This function does not identify the type to Postgres, so Postgres must be able to derive the type from context. When you find yourself in such situation just provide an explicit type in the query using the :: operator.

unknown :: Value ByteString

Identifies the value with the PostgreSQL's "unknown" type, thus leaving it up to Postgres to infer the actual type of the value.

The value transimitted is any value encoded in the Postgres' Text data format. For reference, see the Formats and Format Codes section of the Postgres' documentation.

Warning: Do not use this as part of composite encoders like array since it is the only encoder that doesn't use the binary format.

array :: Array a -> Value a

Lift an array encoder into a value encoder.

foldableArray :: Foldable foldable => NullableOrNot Value element -> Value (foldable element)

Lift a value encoder of element into a unidimensional array encoder of a foldable value.

This function is merely a shortcut to the following expression:

(array . dimension foldl' . element)

You can use it like this:

vectorOfInts :: Value (Vector Int64)
vectorOfInts = foldableArray (nonNullable int8)

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

composite :: Composite a -> Value a

Lift a composite encoder into a value encoder.

Array

data Array a

Generic array encoder.

Here's an example of its usage:

someParamsEncoder :: Params [[Int64]]
someParamsEncoder = param (nonNullable (array (dimension foldl' (dimension foldl' (element (nonNullable int8))))))

Please note that the PostgreSQL IN keyword does not accept an array, but rather a syntactical list of values, thus this encoder is not suited for that. Use a value = ANY($1) condition instead.

Instances

Contravariant Array

Defined in Hasql.Encoders.All

Methods

contramap :: (a' -> a) -> Array a -> Array a'

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

element :: NullableOrNot Value a -> Array a

Lifts a Value encoder into an Array encoder.

dimension :: (forall a. (a -> b -> a) -> a -> c -> a) -> Array b -> Array c

Encoder of an array dimension, which thus provides support for multidimensional arrays.

Accepts:

• An implementation of the left-fold operation, such as Data.Foldable.foldl', which determines the input value.
• A component encoder, which can be either another dimension or element.

Composite

data Composite a

Composite or row-types encoder.

Instances

Contravariant Composite

Defined in Hasql.Encoders.All

Methods

contramap :: (a' -> a) -> Composite a -> Composite a'

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

Divisible Composite

Defined in Hasql.Encoders.All

Methods

divide :: (a -> (b, c)) -> Composite b -> Composite c -> Composite a

conquer :: Composite a

Monoid (Composite a)

Defined in Hasql.Encoders.All

Methods

mempty :: Composite a

mappend :: Composite a -> Composite a -> Composite a

mconcat :: [Composite a] -> Composite a

Semigroup (Composite a)

Defined in Hasql.Encoders.All

Methods

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

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

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

field :: NullableOrNot Value a -> Composite a

Single field of a row-type.