@@ -1,7 +1,8 @@
1{-# LANGUAGE CPP, DeriveDataTypeable, DeriveFunctor #-}
1{-# LANGUAGE CPP, DeriveDataTypeable, DeriveFunctor #-}
2{-# LANGUAGE FlexibleInstances, TypeSynonymInstances #-}
2{-# LANGUAGE FlexibleInstances, TypeSynonymInstances #-}
3{-# LANGUAGE PatternGuards, ScopedTypeVariables #-}
3{-# LANGUAGE PatternGuards, ScopedTypeVariables #-}
4−{-# LANGUAGE RecordWildCards, TemplateHaskell #-}
4+{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE PolyKinds #-}
7Module: Database.PostgreSQL.Simple.FromField
8Module: Database.PostgreSQL.Simple.FromField
@@ -28,12 +29,19 @@ conversion routine, which sacrifices some accuracy for speed. If you
28need accuracy, consider first converting data to a 'Scientific' or 'Rational'
29need accuracy, consider first converting data to a 'Scientific' or 'Rational'
29type, and then converting to a floating-point type. If you are defining
30type, and then converting to a floating-point type. If you are defining
30your own 'Database.PostgreSQL.Simple.FromRow.FromRow' instances, this can be
31your own 'Database.PostgreSQL.Simple.FromRow.FromRow' instances, this can be
31−acheived simply by
32+achieved simply by
32@'fromRational' '<$>' 'Database.PostgreSQL.Simple.FromRow.field'@, although
33@'fromRational' '<$>' 'Database.PostgreSQL.Simple.FromRow.field'@, although
33−this idiom is additionally compatible with PostgreSQL's @numeric@ type.
34+this idiom is additionally compatible with PostgreSQL's @int8@ and @numeric@
34−If this is unacceptable, you may find
35+types. If this is unacceptable, you may find
35'Database.PostgreSQL.Simple.FromRow.fieldWith' useful.
36'Database.PostgreSQL.Simple.FromRow.fieldWith' useful.
38+Also note that while converting to a 'Double' through the 'Scientific' type
39+is likely somewhat faster than converting through the 'Rational' type,
40+the 'Scientific' type has no way to represent @NaN@ and @±Infinity@ values.
41+Thus, if you need precision conversion of regular floating point values
42+and the possibility of receiving these special values from the backend,
43+stick with 'Rational'.
37Because 'FromField' is a typeclass, one may provide conversions to
45Because 'FromField' is a typeclass, one may provide conversions to
38additional Haskell types without modifying postgresql-simple. This is
46additional Haskell types without modifying postgresql-simple. This is
39particularly useful for supporting PostgreSQL types that postgresql-simple
47particularly useful for supporting PostgreSQL types that postgresql-simple
@@ -98,23 +106,28 @@ module Database.PostgreSQL.Simple.FromField
98 , typeOid
106 , typeOid
99 , PQ.Oid(..)
107 , PQ.Oid(..)
100 , PQ.Format(..)
108 , PQ.Format(..)
109+ , pgArrayFieldParser
102 , fromJSONField
113 , fromJSONField
114+ , fromFieldJSONByteString
105#include "MachDeps.h"
117#include "MachDeps.h"
107−import Control.Applicative ( (<|>), (<$>), pure )
119+import Control.Applicative ( Const(Const), (<|>), (<$>), pure, (*>), (<*) )
108import Control.Concurrent.MVar (MVar, newMVar)
120import Control.Concurrent.MVar (MVar, newMVar)
109−import Control.Exception (Exception)
121+import Control.Exception (Exception (toException, fromException))
110import qualified Data.Aeson as JSON
122import qualified Data.Aeson as JSON
111import Data.Attoparsec.ByteString.Char8 hiding (Result)
123import Data.Attoparsec.ByteString.Char8 hiding (Result)
112import Data.ByteString (ByteString)
124import Data.ByteString (ByteString)
113import qualified Data.ByteString.Char8 as B
125import qualified Data.ByteString.Char8 as B
126+import Data.Functor.Identity (Identity(Identity))
114import Data.Int (Int16, Int32, Int64)
127import Data.Int (Int16, Int32, Int64)
115import Data.IORef (IORef, newIORef)
128import Data.IORef (IORef, newIORef)
116import Data.Ratio (Ratio)
129import Data.Ratio (Ratio)
117−import Data.Time ( UTCTime, ZonedTime, LocalTime, Day, TimeOfDay )
130+import Data.Time.Compat ( UTCTime, ZonedTime, LocalTime, Day, TimeOfDay, CalendarDiffTime )
118import Data.Typeable (Typeable, typeOf)
131import Data.Typeable (Typeable, typeOf)
119import Data.Vector (Vector)
132import Data.Vector (Vector)
120import Data.Vector.Mutable (IOVector)
133import Data.Vector.Mutable (IOVector)
@@ -125,7 +138,6 @@ import Database.PostgreSQL.Simple.Ok
125import Database.PostgreSQL.Simple.Types
138import Database.PostgreSQL.Simple.Types
126import Database.PostgreSQL.Simple.TypeInfo as TI
139import Database.PostgreSQL.Simple.TypeInfo as TI
127import qualified Database.PostgreSQL.Simple.TypeInfo.Static as TI
140import qualified Database.PostgreSQL.Simple.TypeInfo.Static as TI
128−import Database.PostgreSQL.Simple.TypeInfo.Macro as TI
129import Database.PostgreSQL.Simple.Time
141import Database.PostgreSQL.Simple.Time
130import Database.PostgreSQL.Simple.Arrays as Arrays
142import Database.PostgreSQL.Simple.Arrays as Arrays
131import qualified Database.PostgreSQL.LibPQ as PQ
143import qualified Database.PostgreSQL.LibPQ as PQ
@@ -135,9 +147,14 @@ import qualified Data.ByteString.Lazy as LB
135import qualified Data.Text as ST
147import qualified Data.Text as ST
136import qualified Data.Text.Encoding as ST
148import qualified Data.Text.Encoding as ST
137import qualified Data.Text.Lazy as LT
149import qualified Data.Text.Lazy as LT
138−import Data.UUID (UUID)
150+import Data.CaseInsensitive (CI)
151+import qualified Data.CaseInsensitive as CI
152+import Data.UUID.Types (UUID)
139−import qualified Data.UUID as UUID
153+import qualified Data.UUID.Types as UUID
140import Data.Scientific (Scientific)
154import Data.Scientific (Scientific)
155+import GHC.Real (infinity, notANumber)
157+import qualified Data.Aeson.Types as JSON
142-- | Exception thrown if conversion from a SQL value to a Haskell
159-- | Exception thrown if conversion from a SQL value to a Haskell
143-- value fails.
160-- value fails.
@@ -165,7 +182,9 @@ data ResultError = Incompatible { errSQLType :: String
165 -- between metadata and actual data in a row).
182 -- between metadata and actual data in a row).
166 deriving (Eq, Show, Typeable)
183 deriving (Eq, Show, Typeable)
168−instance Exception ResultError
185+instance Exception ResultError where
186+ toException = postgresqlExceptionToException
187+ fromException = postgresqlExceptionFromException
170left :: Exception a => a -> Conversion b
189left :: Exception a => a -> Conversion b
171left = conversionError
190left = conversionError
@@ -206,7 +225,7 @@ typename field = typname <$> typeInfo field
207typeInfo :: Field -> Conversion TypeInfo
226typeInfo :: Field -> Conversion TypeInfo
208typeInfo Field{..} = Conversion $ \conn -> do
227typeInfo Field{..} = Conversion $ \conn -> do
209− Ok <$> (getTypeInfo conn =<< PQ.ftype result column)
228+ Ok <$> (getTypeInfo conn typeOid)
211typeInfoByOid :: PQ.Oid -> Conversion TypeInfo
230typeInfoByOid :: PQ.Oid -> Conversion TypeInfo
212typeInfoByOid oid = Conversion $ \conn -> do
231typeInfoByOid oid = Conversion $ \conn -> do
@@ -231,9 +250,11 @@ tableOid Field{..} = toMaybeOid (unsafeDupablePerformIO (PQ.ftable result column
231 then Nothing
250 then Nothing
232 else Just x
251 else Just x
234−-- | If the column has a table associated with it, this returns the number
253+-- | If the column has a table associated with it, this returns the
235−-- off the associated table column. Numbering starts from 0. Analogous
254+-- number of the associated table column. Table columns have
255+-- nonzero numbers. Zero is returned if the specified column is not
256+-- a simple reference to a table column, or when using pre-3.0
236−-- to libpq's @PQftablecol@.
257+-- protocol. Analogous to libpq's @PQftablecol@.
238tableColumn :: Field -> Int
259tableColumn :: Field -> Int
239tableColumn Field{..} = fromCol (unsafeDupablePerformIO (PQ.ftablecol result column))
260tableColumn Field{..} = fromCol (unsafeDupablePerformIO (PQ.ftablecol result column))
@@ -249,16 +270,33 @@ format Field{..} = unsafeDupablePerformIO (PQ.fformat result column)
250instance FromField () where
271instance FromField () where
251 fromField f _bs
272 fromField f _bs
252− | typeOid f /= $(inlineTypoid TI.void) = returnError Incompatible f ""
273+ | typeOid f /= TI.voidOid = returnError Incompatible f ""
253 | otherwise = pure ()
274 | otherwise = pure ()
276+instance (FromField a) => FromField (Const a b) where
277+ fromField f bs = Const <$> fromField f bs
279+instance (FromField a) => FromField (Identity a) where
280+ fromField f bs = Identity <$> fromField f bs
255-- | For dealing with null values. Compatible with any postgresql type
282-- | For dealing with null values. Compatible with any postgresql type
256-- compatible with type @a@. Note that the type is not checked if
283-- compatible with type @a@. Note that the type is not checked if
257-- the value is null, although it is inadvisable to rely on this
284-- the value is null, although it is inadvisable to rely on this
258-- behavior.
285-- behavior.
259−instance (FromField a) => FromField (Maybe a) where
286+instance FromField a => FromField (Maybe a) where
287+ fromField = optionalField fromField
289+-- | For dealing with SQL @null@ values outside of the 'FromField' class.
290+-- Alternatively, one could use 'Control.Applicative.optional', but that
291+-- also turns type and conversion errors into 'Nothing', whereas this is
292+-- more specific and turns only @null@ values into 'Nothing'.
294+optionalField :: FieldParser a -> FieldParser (Maybe a)
295+optionalField p f mv =
260− fromField _ Nothing = pure Nothing
297+ Nothing -> pure Nothing
261− fromField f bs = Just <$> fromField f bs
298+ Just _ -> Just <$> p f mv
299+{-# INLINE optionalField #-}
263-- | compatible with any data type, but the value must be null
301-- | compatible with any data type, but the value must be null
264instance FromField Null where
302instance FromField Null where
@@ -268,30 +306,30 @@ instance FromField Null where
269instance FromField Bool where
307instance FromField Bool where
270 fromField f bs
308 fromField f bs
271− | typeOid f /= $(inlineTypoid TI.bool) = returnError Incompatible f ""
309+ | typeOid f /= TI.boolOid = returnError Incompatible f ""
272 | bs == Nothing = returnError UnexpectedNull f ""
310 | bs == Nothing = returnError UnexpectedNull f ""
273 | bs == Just "t" = pure True
311 | bs == Just "t" = pure True
274 | bs == Just "f" = pure False
312 | bs == Just "f" = pure False
275 | otherwise = returnError ConversionFailed f ""
313 | otherwise = returnError ConversionFailed f ""
277−-- | \"char\"
315+-- | \"char\", bpchar
278instance FromField Char where
316instance FromField Char where
279− fromField f bs =
317+ fromField f bs0 =
280− if typeOid f /= $(inlineTypoid TI.char)
318+ if (eq TI.charOid \/ eq TI.bpcharOid) (typeOid f)
281− then returnError Incompatible f ""
282− else case bs of
319+ then case bs0 of
283 Nothing -> returnError UnexpectedNull f ""
320 Nothing -> returnError UnexpectedNull f ""
284 Just bs -> if B.length bs /= 1
321 Just bs -> if B.length bs /= 1
285 then returnError ConversionFailed f "length not 1"
322 then returnError ConversionFailed f "length not 1"
286 else return $! (B.head bs)
323 else return $! (B.head bs)
324+ else returnError Incompatible f ""
289instance FromField Int16 where
327instance FromField Int16 where
290− fromField = atto ok16 $ signed decimal
328+ fromField = attoFieldParser ok16 $ signed decimal
292-- | int2, int4
330-- | int2, int4
293instance FromField Int32 where
331instance FromField Int32 where
294− fromField = atto ok32 $ signed decimal
332+ fromField = attoFieldParser ok32 $ signed decimal
296#if WORD_SIZE_IN_BITS < 64
334#if WORD_SIZE_IN_BITS < 64
297-- | int2, int4, and if compiled as 64-bit code, int8 as well.
335-- | int2, int4, and if compiled as 64-bit code, int8 as well.
@@ -301,50 +339,64 @@ instance FromField Int32 where
301-- This library was compiled as 64-bit code.
339-- This library was compiled as 64-bit code.
303instance FromField Int where
341instance FromField Int where
304− fromField = atto okInt $ signed decimal
342+ fromField = attoFieldParser okInt $ signed decimal
306-- | int2, int4, int8
344-- | int2, int4, int8
307instance FromField Int64 where
345instance FromField Int64 where
308− fromField = atto ok64 $ signed decimal
346+ fromField = attoFieldParser ok64 $ signed decimal
310-- | int2, int4, int8
348-- | int2, int4, int8
311instance FromField Integer where
349instance FromField Integer where
312− fromField = atto ok64 $ signed decimal
350+ fromField = attoFieldParser ok64 $ signed decimal
314-- | int2, float4 (Uses attoparsec's 'double' routine, for
352-- | int2, float4 (Uses attoparsec's 'double' routine, for
315-- better accuracy convert to 'Scientific' or 'Rational' first)
353-- better accuracy convert to 'Scientific' or 'Rational' first)
316instance FromField Float where
354instance FromField Float where
317− fromField = atto ok (realToFrac <$> double)
355+ fromField = attoFieldParser ok (realToFrac <$> pg_double)
318− where ok = $(mkCompats [TI.float4,TI.int2])
356+ where ok = eq TI.float4Oid \/ eq TI.int2Oid
320-- | int2, int4, float4, float8 (Uses attoparsec's 'double' routine, for
358-- | int2, int4, float4, float8 (Uses attoparsec's 'double' routine, for
321-- better accuracy convert to 'Scientific' or 'Rational' first)
359-- better accuracy convert to 'Scientific' or 'Rational' first)
322instance FromField Double where
360instance FromField Double where
323− fromField = atto ok double
361+ fromField = attoFieldParser ok pg_double
324− where ok = $(mkCompats [TI.float4,TI.float8,TI.int2,TI.int4])
362+ where ok = eq TI.float4Oid \/ eq TI.float8Oid \/ eq TI.int2Oid \/ eq TI.int4Oid
326−-- | int2, int4, float4, float8, numeric
364+-- | int2, int4, int8, float4, float8, numeric
327instance FromField (Ratio Integer) where
365instance FromField (Ratio Integer) where
328− fromField = atto ok rational
366+ fromField = attoFieldParser ok pg_rational
329− where ok = $(mkCompats [TI.float4,TI.float8,TI.int2,TI.int4,TI.numeric])
367+ where ok = eq TI.float4Oid \/ eq TI.float8Oid \/ eq TI.int2Oid \/ eq TI.int4Oid \/ eq TI.int8Oid \/ eq TI.numericOid
331−-- | int2, int4, float4, float8, numeric
369+-- | int2, int4, int8, float4, float8, numeric
332instance FromField Scientific where
370instance FromField Scientific where
333− fromField = atto ok rational
371+ fromField = attoFieldParser ok rational
334− where ok = $(mkCompats [TI.float4,TI.float8,TI.int2,TI.int4,TI.numeric])
372+ where ok = eq TI.float4Oid \/ eq TI.float8Oid \/ eq TI.int2Oid \/ eq TI.int4Oid \/ eq TI.int8Oid \/ eq TI.numericOid
336unBinary :: Binary t -> t
374unBinary :: Binary t -> t
337unBinary (Binary x) = x
375unBinary (Binary x) = x
377+pg_double :: Parser Double
379+ = (string "NaN" *> pure ( 0 / 0))
380+ <|> (string "Infinity" *> pure ( 1 / 0))
381+ <|> (string "-Infinity" *> pure (-1 / 0))
384+pg_rational :: Parser Rational
386+ = (string "NaN" *> pure notANumber )
387+ <|> (string "Infinity" *> pure infinity )
388+ <|> (string "-Infinity" *> pure (-infinity))
339-- | bytea, name, text, \"char\", bpchar, varchar, unknown
391-- | bytea, name, text, \"char\", bpchar, varchar, unknown
340instance FromField SB.ByteString where
392instance FromField SB.ByteString where
341− fromField f dat = if typeOid f == $(inlineTypoid TI.bytea)
393+ fromField f dat = if typeOid f == TI.byteaOid
342 then unBinary <$> fromField f dat
394 then unBinary <$> fromField f dat
343 else doFromField f okText' pure dat
395 else doFromField f okText' pure dat
346instance FromField PQ.Oid where
398instance FromField PQ.Oid where
347− fromField f dat = PQ.Oid <$> atto (== $(inlineTypoid TI.oid)) decimal f dat
399+ fromField f dat = PQ.Oid <$> attoFieldParser (== TI.oidOid) decimal f dat
349-- | bytea, name, text, \"char\", bpchar, varchar, unknown
401-- | bytea, name, text, \"char\", bpchar, varchar, unknown
350instance FromField LB.ByteString where
402instance FromField LB.ByteString where
@@ -352,7 +404,7 @@ instance FromField LB.ByteString where
353unescapeBytea :: Field -> SB.ByteString
405unescapeBytea :: Field -> SB.ByteString
354 -> Conversion (Binary SB.ByteString)
406 -> Conversion (Binary SB.ByteString)
355−unescapeBytea f str = case unsafeDupablePerformIO (PQ.unescapeBytea str) of
407+unescapeBytea f str' = case unsafeDupablePerformIO (PQ.unescapeBytea str') of
356 Nothing -> returnError ConversionFailed f "unescapeBytea failed"
408 Nothing -> returnError ConversionFailed f "unescapeBytea failed"
357 Just str -> pure (Binary str)
409 Just str -> pure (Binary str)
@@ -375,54 +427,85 @@ instance FromField ST.Text where
375instance FromField LT.Text where
427instance FromField LT.Text where
376 fromField f dat = LT.fromStrict <$> fromField f dat
428 fromField f dat = LT.fromStrict <$> fromField f dat
431+instance FromField (CI ST.Text) where
432+ fromField f mdat = do
435+ then returnError Incompatible f ""
437+ Nothing -> returnError UnexpectedNull f ""
438+ Just dat -> either left (pure . CI.mk)
439+ (ST.decodeUtf8' dat)
442+instance FromField (CI LT.Text) where
443+ fromField f mdat = do
446+ then returnError Incompatible f ""
448+ Nothing -> returnError UnexpectedNull f ""
449+ Just dat -> either left (pure . CI.mk . LT.fromStrict)
450+ (ST.decodeUtf8' dat)
378-- | name, text, \"char\", bpchar, varchar
452-- | name, text, \"char\", bpchar, varchar
379instance FromField [Char] where
453instance FromField [Char] where
380 fromField f dat = ST.unpack <$> fromField f dat
454 fromField f dat = ST.unpack <$> fromField f dat
382-- | timestamptz
456-- | timestamptz
383instance FromField UTCTime where
457instance FromField UTCTime where
384− fromField = ff $(inlineTypoid TI.timestamptz) "UTCTime" parseUTCTime
458+ fromField = ff TI.timestamptzOid "UTCTime" parseUTCTime
386-- | timestamptz
460-- | timestamptz
387instance FromField ZonedTime where
461instance FromField ZonedTime where
388− fromField = ff $(inlineTypoid TI.timestamptz) "ZonedTime" parseZonedTime
462+ fromField = ff TI.timestamptzOid "ZonedTime" parseZonedTime
390-- | timestamp
464-- | timestamp
391instance FromField LocalTime where
465instance FromField LocalTime where
392− fromField = ff $(inlineTypoid TI.timestamp) "LocalTime" parseLocalTime
466+ fromField = ff TI.timestampOid "LocalTime" parseLocalTime
395instance FromField Day where
469instance FromField Day where
396− fromField = ff $(inlineTypoid TI.date) "Day" parseDay
470+ fromField = ff TI.dateOid "Day" parseDay
399instance FromField TimeOfDay where
473instance FromField TimeOfDay where
400− fromField = ff $(inlineTypoid TI.time) "TimeOfDay" parseTimeOfDay
474+ fromField = ff TI.timeOid "TimeOfDay" parseTimeOfDay
402-- | timestamptz
476-- | timestamptz
403instance FromField UTCTimestamp where
477instance FromField UTCTimestamp where
404− fromField = ff $(inlineTypoid TI.timestamptz) "UTCTimestamp" parseUTCTimestamp
478+ fromField = ff TI.timestamptzOid "UTCTimestamp" parseUTCTimestamp
406-- | timestamptz
480-- | timestamptz
407instance FromField ZonedTimestamp where
481instance FromField ZonedTimestamp where
408− fromField = ff $(inlineTypoid TI.timestamptz) "ZonedTimestamp" parseZonedTimestamp
482+ fromField = ff TI.timestamptzOid "ZonedTimestamp" parseZonedTimestamp
410-- | timestamp
484-- | timestamp
411instance FromField LocalTimestamp where
485instance FromField LocalTimestamp where
412− fromField = ff $(inlineTypoid TI.timestamp) "LocalTimestamp" parseLocalTimestamp
486+ fromField = ff TI.timestampOid "LocalTimestamp" parseLocalTimestamp
415instance FromField Date where
489instance FromField Date where
416− fromField = ff $(inlineTypoid TI.date) "Date" parseDate
490+ fromField = ff TI.dateOid "Date" parseDate
492+-- | interval. Requires you to configure intervalstyle as @iso_8601@.
494+-- You can configure intervalstyle on every connection with a @SET@ command,
495+-- but for better performance you may want to configure it permanently in the
496+-- file found with @SHOW config_file;@ .
498+instance FromField CalendarDiffTime where
499+ fromField = ff TI.intervalOid "CalendarDiffTime" parseCalendarDiffTime
418ff :: PQ.Oid -> String -> (B8.ByteString -> Either String a)
501ff :: PQ.Oid -> String -> (B8.ByteString -> Either String a)
419 -> Field -> Maybe B8.ByteString -> Conversion a
502 -> Field -> Maybe B8.ByteString -> Conversion a
420−ff compatOid hsType parse f mstr =
503+ff compatOid hsType parseBS f mstr =
421 if typeOid f /= compatOid
504 if typeOid f /= compatOid
422 then err Incompatible ""
505 then err Incompatible ""
423 else case mstr of
506 else case mstr of
424 Nothing -> err UnexpectedNull ""
507 Nothing -> err UnexpectedNull ""
425− Just str -> case parse str of
508+ Just str -> case parseBS str of
426 Left msg -> err ConversionFailed msg
509 Left msg -> err ConversionFailed msg
427 Right val -> return val
510 Right val -> return val
@@ -444,27 +527,29 @@ instance (FromField a, FromField b) => FromField (Either a b) where
445-- | any postgresql array whose elements are compatible with type @a@
528-- | any postgresql array whose elements are compatible with type @a@
446instance (FromField a, Typeable a) => FromField (PGArray a) where
529instance (FromField a, Typeable a) => FromField (PGArray a) where
447− fromField f mdat = do
530+ fromField = pgArrayFieldParser fromField
532+pgArrayFieldParser :: Typeable a => FieldParser a -> FieldParser (PGArray a)
533+pgArrayFieldParser fieldParser f mdat = do
448 info <- typeInfo f
534 info <- typeInfo f
449 case info of
535 case info of
450 TI.Array{} ->
536 TI.Array{} ->
451 case mdat of
537 case mdat of
452 Nothing -> returnError UnexpectedNull f ""
538 Nothing -> returnError UnexpectedNull f ""
453 Just dat -> do
539 Just dat -> do
454− case parseOnly (fromArray info f) dat of
540+ case parseOnly (fromArray fieldParser info f) dat of
455 Left err -> returnError ConversionFailed f err
541 Left err -> returnError ConversionFailed f err
456 Right conv -> PGArray <$> conv
542 Right conv -> PGArray <$> conv
457 _ -> returnError Incompatible f ""
543 _ -> returnError Incompatible f ""
459−fromArray :: (FromField a)
460− => TypeInfo -> Field -> Parser (Conversion [a])
545+fromArray :: FieldParser a -> TypeInfo -> Field -> Parser (Conversion [a])
461−fromArray typeInfo f = sequence . (parseIt <$>) <$> array delim
546+fromArray fieldParser typInfo f = sequence . (parseIt <$>) <$> array delim
463− delim = typdelim (typelem typeInfo)
548+ delim = typdelim (typelem typInfo)
464− fElem = f{ typeOid = typoid (typelem typeInfo) }
549+ fElem = f{ typeOid = typoid (typelem typInfo) }
466 parseIt item =
551 parseIt item =
467− fromField f' $ if item' == "NULL" then Nothing else Just item'
552+ fieldParser f' $ if item == Arrays.Plain "NULL" then Nothing else Just item'
469 item' = fmt delim item
554 item' = fmt delim item
470 f' | Arrays.Array _ <- item = f
555 f' | Arrays.Array _ <- item = f
@@ -479,7 +564,7 @@ instance (FromField a, Typeable a) => FromField (IOVector a) where
480instance FromField UUID where
565instance FromField UUID where
481 fromField f mbs =
566 fromField f mbs =
482− if typeOid f /= $(inlineTypoid TI.uuid)
567+ if typeOid f /= TI.uuidOid
483 then returnError Incompatible f ""
568 then returnError Incompatible f ""
484 else case mbs of
569 else case mbs of
485 Nothing -> returnError UnexpectedNull f ""
570 Nothing -> returnError UnexpectedNull f ""
@@ -488,26 +573,26 @@ instance FromField UUID where
488 Nothing -> returnError ConversionFailed f "Invalid UUID"
573 Nothing -> returnError ConversionFailed f "Invalid UUID"
489 Just uuid -> pure uuid
574 Just uuid -> pure uuid
491−-- | json
576+-- | json, jsonb
492instance FromField JSON.Value where
577instance FromField JSON.Value where
493− fromField f mbs =
578+ fromField f mbs = parseBS =<< fromFieldJSONByteString f mbs
579+ where parseBS bs = case JSON.eitherDecodeStrict' bs of
580+ Left err -> returnError ConversionFailed f err
581+ Right val -> pure val
583+-- | Return the JSON ByteString directly
586+fromFieldJSONByteString :: Field -> Maybe ByteString -> Conversion ByteString
587+fromFieldJSONByteString f mbs =
494− if typeOid f /= $(inlineTypoid TI.json) && typeOid f /= $(inlineTypoid TI.jsonb)
588+ if typeOid f /= TI.jsonOid && typeOid f /= TI.jsonbOid
495 then returnError Incompatible f ""
589 then returnError Incompatible f ""
496 else case mbs of
590 else case mbs of
497 Nothing -> returnError UnexpectedNull f ""
591 Nothing -> returnError UnexpectedNull f ""
498− Just bs ->
592+ Just bs -> pure bs
499−#if MIN_VERSION_aeson(0,6,3)
500− case JSON.eitherDecodeStrict' bs of
501−#elif MIN_VERSION_bytestring(0,10,0)
502− case JSON.eitherDecode' $ LB.fromStrict bs of
504− case JSON.eitherDecode' $ LB.fromChunks [bs] of
506− Left err -> returnError ConversionFailed f err
507− Right val -> pure val
509-- | Parse a field to a JSON 'JSON.Value' and convert that into a
594-- | Parse a field to a JSON 'JSON.Value' and convert that into a
510−-- Haskell value using 'JSON.fromJSON'.
595+-- Haskell value using the 'JSON.FromJSON' instance.
512-- This can be used as the default implementation for the 'fromField'
597-- This can be used as the default implementation for the 'fromField'
513-- method for Haskell types that have a JSON representation in
598-- method for Haskell types that have a JSON representation in
@@ -515,14 +600,23 @@ instance FromField JSON.Value where
516-- The 'Typeable' constraint is required to show more informative
601-- The 'Typeable' constraint is required to show more informative
517-- error messages when parsing fails.
602-- error messages when parsing fails.
604+-- Note that @fromJSONField :: FieldParser ('Maybe' Foo)@ will return
605+-- @'Nothing'@ on the json @null@ value, and return an exception on SQL @null@
606+-- value. Alternatively, one could write @'optionalField' fromJSONField@
607+-- that will return @Nothing@ on SQL @null@, and otherwise will call
608+-- @fromJSONField :: FieldParser Foo@ and then return @'Just'@ the
609+-- result value, or return its exception. If one would
610+-- like to return @Nothing@ on both the SQL @null@ and json @null@ values,
611+-- one way to do it would be to write
612+-- @\\f mv -> 'Control.Monad.join' '<$>' optionalField fromJSONField f mv@
518fromJSONField :: (JSON.FromJSON a, Typeable a) => FieldParser a
613fromJSONField :: (JSON.FromJSON a, Typeable a) => FieldParser a
519fromJSONField f mbBs = do
614fromJSONField f mbBs = do
520 value <- fromField f mbBs
615 value <- fromField f mbBs
521− case JSON.fromJSON value of
616+ case JSON.ifromJSON value of
522− JSON.Error err -> returnError ConversionFailed f $
617+ JSON.IError path err -> returnError ConversionFailed f $
523− "JSON decoding error: " ++ err
618+ "JSON decoding error: " ++ (JSON.formatError path err)
524− JSON.Success x -> pure x
619+ JSON.ISuccess x -> pure x
527-- | Compatible with the same set of types as @a@. Note that
621-- | Compatible with the same set of types as @a@. Note that
528-- modifying the 'IORef' does not have any effects outside
622-- modifying the 'IORef' does not have any effects outside
@@ -539,20 +633,33 @@ instance FromField a => FromField (MVar a) where
539type Compat = PQ.Oid -> Bool
633type Compat = PQ.Oid -> Bool
541okText, okText', okBinary, ok16, ok32, ok64, okInt :: Compat
635okText, okText', okBinary, ok16, ok32, ok64, okInt :: Compat
542−okText = $( mkCompats [ TI.name, TI.text, TI.char,
636+okText = eq TI.nameOid \/ eq TI.textOid \/ eq TI.charOid
543− TI.bpchar, TI.varchar ] )
637+ \/ eq TI.bpcharOid \/ eq TI.varcharOid
544−okText' = $( mkCompats [ TI.name, TI.text, TI.char,
638+okText' = eq TI.nameOid \/ eq TI.textOid \/ eq TI.charOid
545− TI.bpchar, TI.varchar, TI.unknown ] )
639+ \/ eq TI.bpcharOid \/ eq TI.varcharOid \/ eq TI.unknownOid
546−okBinary = (== $( inlineTypoid TI.bytea ))
640+okBinary = eq TI.byteaOid
547−ok16 = (== $( inlineTypoid TI.int2 ))
641+ok16 = eq TI.int2Oid
548−ok32 = $( mkCompats [TI.int2,TI.int4] )
642+ok32 = eq TI.int2Oid \/ eq TI.int4Oid
549−ok64 = $( mkCompats [TI.int2,TI.int4,TI.int8] )
643+ok64 = eq TI.int2Oid \/ eq TI.int4Oid \/ eq TI.int8Oid
550#if WORD_SIZE_IN_BITS < 64
644#if WORD_SIZE_IN_BITS < 64
551okInt = ok32
645okInt = ok32
553okInt = ok64
647okInt = ok64
650+-- | eq and \/ are used to imlement what Macro stuff did,
651+-- i.e. mkCompats and inlineTypoid
652+eq :: PQ.Oid -> PQ.Oid -> Bool
657+(\/) :: (PQ.Oid -> Bool)
660+f \/ g = \x -> f x || g x
556doFromField :: forall a . (Typeable a)
663doFromField :: forall a . (Typeable a)
557 => Field -> Compat -> (ByteString -> Conversion a)
664 => Field -> Compat -> (ByteString -> Conversion a)
558 -> Maybe ByteString -> Conversion a
665 -> Maybe ByteString -> Conversion a
@@ -577,10 +684,22 @@ returnError mkErr f msg = do
577 (show (typeOf (undefined :: a)))
684 (show (typeOf (undefined :: a)))
687+-- | Construct a field parser from an attoparsec parser. An 'Incompatible' error is thrown if the
688+-- PostgreSQL oid does not match the specified predicate.
691+-- instance FromField Int16 where
692+-- fromField = attoFieldParser ok16 (signed decimal)
580−atto :: forall a. (Typeable a)
696+attoFieldParser :: forall a. (Typeable a)
581− => Compat -> Parser a -> Field -> Maybe ByteString
697+ => (PQ.Oid -> Bool)
582− -> Conversion a
698+ -- ^ Predicate for whether the postgresql type oid is compatible with this parser
700+ -- ^ An attoparsec parser.
583−atto types p0 f dat = doFromField f types (go p0) dat
702+attoFieldParser types p0 f dat = doFromField f types (go p0) dat
585 go :: Parser a -> ByteString -> Conversion a
704 go :: Parser a -> ByteString -> Conversion a