Copyright	(c) 2012 Leon P Smith
License	BSD3
Maintainer	Leon P Smith <leon@melding-monads.com>
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Database.PostgreSQL.Simple.FromRow

Description

The FromRow typeclass, for converting a row of results returned by a SQL query into a more useful Haskell representation.

Predefined instances are provided for tuples containing up to ten elements. The instances for Maybe types return Nothing if all the columns that would have been otherwise consumed are null, otherwise it attempts a regular conversion.

Synopsis

class FromRow a where
data RowParser a
field :: FromField a => RowParser a
fieldWith :: FieldParser a -> RowParser a
numFieldsRemaining :: RowParser Int

Documentation

class FromRow a where #

A collection type that can be converted from a sequence of fields. Instances are provided for tuples up to 10 elements and lists of any length.

Note that instances can be defined outside of postgresql-simple, which is often useful. For example, here's an instance for a user-defined pair:

data User = User { name :: String, fileQuota :: Int }

instance FromRow User where
    fromRow = User <$> field <*> field

The number of calls to field must match the number of fields returned in a single row of the query result. Otherwise, a ConversionFailed exception will be thrown.

Note that field evaluates its result to WHNF, so the caveats listed in mysql-simple and very early versions of postgresql-simple no longer apply. Instead, look at the caveats associated with user-defined implementations of fromField.

Methods

fromRow :: RowParser a #

fromRow :: (Generic a, GFromRow (Rep a)) => RowParser a #

Instances

FromField a => FromRow [a] #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser [a] #
FromField a => FromRow (Maybe [a]) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe [a]) #
(FromField a, FromField b) => FromRow (Maybe (a, b)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (a, b)) #
(FromField a, FromField b, FromField c) => FromRow (Maybe (a, b, c)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (a, b, c)) #
(FromField a, FromField b, FromField c, FromField d) => FromRow (Maybe (a, b, c, d)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (a, b, c, d)) #
(FromField a, FromField b, FromField c, FromField d, FromField e) => FromRow (Maybe (a, b, c, d, e)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (a, b, c, d, e)) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f) => FromRow (Maybe (a, b, c, d, e, f)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (a, b, c, d, e, f)) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f, FromField g) => FromRow (Maybe (a, b, c, d, e, f, g)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (a, b, c, d, e, f, g)) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f, FromField g, FromField h) => FromRow (Maybe (a, b, c, d, e, f, g, h)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (a, b, c, d, e, f, g, h)) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f, FromField g, FromField h, FromField i) => FromRow (Maybe (a, b, c, d, e, f, g, h, i)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (a, b, c, d, e, f, g, h, i)) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f, FromField g, FromField h, FromField i, FromField j) => FromRow (Maybe (a, b, c, d, e, f, g, h, i, j)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (a, b, c, d, e, f, g, h, i, j)) #
FromField a => FromRow (Maybe (Vector a)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (Vector a)) #
FromField a => FromRow (Maybe (Only a)) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Maybe (Only a)) #
FromField a => FromRow (Vector a) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Vector a) #
FromField a => FromRow (Only a) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (Only a) #
(FromField a, FromField b) => FromRow (a, b) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a, b) #
(FromRow a, FromRow b) => FromRow (a :. b) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a :. b) #
(FromField a, FromField b, FromField c) => FromRow (a, b, c) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a, b, c) #
(FromField a, FromField b, FromField c, FromField d) => FromRow (a, b, c, d) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a, b, c, d) #
(FromField a, FromField b, FromField c, FromField d, FromField e) => FromRow (a, b, c, d, e) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a, b, c, d, e) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f) => FromRow (a, b, c, d, e, f) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a, b, c, d, e, f) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f, FromField g) => FromRow (a, b, c, d, e, f, g) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a, b, c, d, e, f, g) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f, FromField g, FromField h) => FromRow (a, b, c, d, e, f, g, h) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a, b, c, d, e, f, g, h) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f, FromField g, FromField h, FromField i) => FromRow (a, b, c, d, e, f, g, h, i) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a, b, c, d, e, f, g, h, i) #
(FromField a, FromField b, FromField c, FromField d, FromField e, FromField f, FromField g, FromField h, FromField i, FromField j) => FromRow (a, b, c, d, e, f, g, h, i, j) #
Instance details Defined in Database.PostgreSQL.Simple.FromRow Methods fromRow :: RowParser (a, b, c, d, e, f, g, h, i, j) #

data RowParser a #

Instances

Monad RowParser #
Instance details Defined in Database.PostgreSQL.Simple.Internal Methods (>>=) :: RowParser a -> (a -> RowParser b) -> RowParser b # (>>) :: RowParser a -> RowParser b -> RowParser b # return :: a -> RowParser a # fail :: String -> RowParser a #
Functor RowParser #
Instance details Defined in Database.PostgreSQL.Simple.Internal Methods fmap :: (a -> b) -> RowParser a -> RowParser b # (<$) :: a -> RowParser b -> RowParser a #
Applicative RowParser #
Instance details Defined in Database.PostgreSQL.Simple.Internal Methods pure :: a -> RowParser a # (<>) :: RowParser (a -> b) -> RowParser a -> RowParser b # liftA2 :: (a -> b -> c) -> RowParser a -> RowParser b -> RowParser c # (>) :: RowParser a -> RowParser b -> RowParser b # (<*) :: RowParser a -> RowParser b -> RowParser a #
Alternative RowParser #
Instance details Defined in Database.PostgreSQL.Simple.Internal Methods empty :: RowParser a # (<\|>) :: RowParser a -> RowParser a -> RowParser a # some :: RowParser a -> RowParser [a] # many :: RowParser a -> RowParser [a] #

field :: FromField a => RowParser a #

fieldWith :: FieldParser a -> RowParser a #

numFieldsRemaining :: RowParser Int #