PostgreSQL.Result.Row

Things in this module are used for processing Postgres query result rows.

Documentation

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

runRow :: (Monad m, Applicative row) => Row a -> (forall x. ColumnRequest x -> m (row x)) -> m (row a)

Translate a Row expression. Validate things in m and parse each row in row.

Since: 0.0.0

runRowPq :: (MonadError ProcessorErrors m, MonadIO m) => Result -> Row a -> m (RowNum -> m a)

Generate a row runner for libpq's Result.

Since: 0.0.0

data ColumnRequest a

Request a column

Since: 0.0.0

Constructors

ColumnReqest

Since: 0.0.0

Fields

• columnRequest_position :: ColumnPosition

  Location of the column

  Since: 0.0.0

• columnRequest_parser :: Column a

  Parser for the column

  Since: 0.0.0

Instances

Functor ColumnRequest

Defined in PostgreSQL.Result.Row

Methods

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

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

data ColumnPosition

Position of a column

Since: 0.0.0

Constructors

FixedColumn ColumnNum

Column is at a fixed index.

Since: 0.0.0

NamedColumn ByteString

Column has a fixed name.

Since: 0.0.0

Instances

Eq ColumnPosition

Defined in PostgreSQL.Result.Row

Methods

(==) :: ColumnPosition -> ColumnPosition -> Bool

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

Ord ColumnPosition

Defined in PostgreSQL.Result.Row

Methods

compare :: ColumnPosition -> ColumnPosition -> Ordering

(<) :: ColumnPosition -> ColumnPosition -> Bool

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

(>) :: ColumnPosition -> ColumnPosition -> Bool

(>=) :: ColumnPosition -> ColumnPosition -> Bool

max :: ColumnPosition -> ColumnPosition -> ColumnPosition

min :: ColumnPosition -> ColumnPosition -> ColumnPosition

Read ColumnPosition

Defined in PostgreSQL.Result.Row

Methods

readsPrec :: Int -> ReadS ColumnPosition

readList :: ReadS [ColumnPosition]

readPrec :: ReadPrec ColumnPosition

readListPrec :: ReadPrec [ColumnPosition]

Show ColumnPosition

Defined in PostgreSQL.Result.Row

Methods

showsPrec :: Int -> ColumnPosition -> ShowS

show :: ColumnPosition -> String

showList :: [ColumnPosition] -> ShowS

Combinators

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

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)

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

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)

Helpers

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)

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)