@@ -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
@@ -27,9 +28,19 @@ Note that the 'Float' and 'Double' instances use attoparsec's 'double'
27conversion routine, which sacrifices some accuracy for speed. If you
28conversion 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
30−your own 'ToRow' instances, this can be acheived simply by
31+your own 'Database.PostgreSQL.Simple.FromRow.FromRow' instances, this can be
33+@'fromRational' '<$>' 'Database.PostgreSQL.Simple.FromRow.field'@, although
31−@'fromRational' '<$>' 'field'@, although this idiom additionally compatible
34+this idiom is additionally compatible with PostgreSQL's @int8@ and @numeric@
32−with PostgreSQL's @numeric@ type.
35+types. If this is unacceptable, you may find
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'.
34Because 'FromField' is a typeclass, one may provide conversions to
45Because 'FromField' is a typeclass, one may provide conversions to
35additional Haskell types without modifying postgresql-simple. This is
46additional Haskell types without modifying postgresql-simple. This is
@@ -95,24 +106,28 @@ module Database.PostgreSQL.Simple.FromField
95 , typeOid
106 , typeOid
96 , PQ.Oid(..)
107 , PQ.Oid(..)
97 , PQ.Format(..)
108 , PQ.Format(..)
109+ , pgArrayFieldParser
99 , fromJSONField
113 , fromJSONField
114+ , fromFieldJSONByteString
102#include "MachDeps.h"
117#include "MachDeps.h"
104−import Control.Applicative
119+import Control.Applicative ( Const(Const), (<|>), (<$>), pure, (*>), (<*) )
105− ( Applicative, (<|>), (<$>), pure )
106import Control.Concurrent.MVar (MVar, newMVar)
120import Control.Concurrent.MVar (MVar, newMVar)
107−import Control.Exception (Exception)
121+import Control.Exception (Exception (toException, fromException))
108import qualified Data.Aeson as JSON
122import qualified Data.Aeson as JSON
109−import Data.Attoparsec.Char8 hiding (Result)
123+import Data.Attoparsec.ByteString.Char8 hiding (Result)
110import Data.ByteString (ByteString)
124import Data.ByteString (ByteString)
111import qualified Data.ByteString.Char8 as B
125import qualified Data.ByteString.Char8 as B
126+import Data.Functor.Identity (Identity(Identity))
112import Data.Int (Int16, Int32, Int64)
127import Data.Int (Int16, Int32, Int64)
113import Data.IORef (IORef, newIORef)
128import Data.IORef (IORef, newIORef)
114import Data.Ratio (Ratio)
129import Data.Ratio (Ratio)
115−import Data.Time ( UTCTime, ZonedTime, LocalTime, Day, TimeOfDay )
130+import Data.Time.Compat ( UTCTime, ZonedTime, LocalTime, Day, TimeOfDay, CalendarDiffTime )
116import Data.Typeable (Typeable, typeOf)
131import Data.Typeable (Typeable, typeOf)
117import Data.Vector (Vector)
132import Data.Vector (Vector)
118import Data.Vector.Mutable (IOVector)
133import Data.Vector.Mutable (IOVector)
@@ -123,7 +138,6 @@ import Database.PostgreSQL.Simple.Ok
123import Database.PostgreSQL.Simple.Types
138import Database.PostgreSQL.Simple.Types
124import Database.PostgreSQL.Simple.TypeInfo as TI
139import Database.PostgreSQL.Simple.TypeInfo as TI
125import qualified Database.PostgreSQL.Simple.TypeInfo.Static as TI
140import qualified Database.PostgreSQL.Simple.TypeInfo.Static as TI
126−import Database.PostgreSQL.Simple.TypeInfo.Macro as TI
127import Database.PostgreSQL.Simple.Time
141import Database.PostgreSQL.Simple.Time
128import Database.PostgreSQL.Simple.Arrays as Arrays
142import Database.PostgreSQL.Simple.Arrays as Arrays
129import qualified Database.PostgreSQL.LibPQ as PQ
143import qualified Database.PostgreSQL.LibPQ as PQ
@@ -133,9 +147,14 @@ import qualified Data.ByteString.Lazy as LB
133import qualified Data.Text as ST
147import qualified Data.Text as ST
134import qualified Data.Text.Encoding as ST
148import qualified Data.Text.Encoding as ST
135import qualified Data.Text.Lazy as LT
149import qualified Data.Text.Lazy as LT
136−import Data.UUID (UUID)
150+import Data.CaseInsensitive (CI)
151+import qualified Data.CaseInsensitive as CI
152+import Data.UUID.Types (UUID)
137−import qualified Data.UUID as UUID
153+import qualified Data.UUID.Types as UUID
138import Data.Scientific (Scientific)
154import Data.Scientific (Scientific)
155+import GHC.Real (infinity, notANumber)
157+import qualified Data.Aeson.Types as JSON
140-- | Exception thrown if conversion from a SQL value to a Haskell
159-- | Exception thrown if conversion from a SQL value to a Haskell
141-- value fails.
160-- value fails.
@@ -163,7 +182,9 @@ data ResultError = Incompatible { errSQLType :: String
163 -- between metadata and actual data in a row).
182 -- between metadata and actual data in a row).
164 deriving (Eq, Show, Typeable)
183 deriving (Eq, Show, Typeable)
166−instance Exception ResultError
185+instance Exception ResultError where
186+ toException = postgresqlExceptionToException
187+ fromException = postgresqlExceptionFromException
168left :: Exception a => a -> Conversion b
189left :: Exception a => a -> Conversion b
169left = conversionError
190left = conversionError
@@ -204,7 +225,7 @@ typename field = typname <$> typeInfo field
205typeInfo :: Field -> Conversion TypeInfo
226typeInfo :: Field -> Conversion TypeInfo
206typeInfo Field{..} = Conversion $ \conn -> do
227typeInfo Field{..} = Conversion $ \conn -> do
207− Ok <$> (getTypeInfo conn =<< PQ.ftype result column)
228+ Ok <$> (getTypeInfo conn typeOid)
209typeInfoByOid :: PQ.Oid -> Conversion TypeInfo
230typeInfoByOid :: PQ.Oid -> Conversion TypeInfo
210typeInfoByOid oid = Conversion $ \conn -> do
231typeInfoByOid oid = Conversion $ \conn -> do
@@ -229,9 +250,11 @@ tableOid Field{..} = toMaybeOid (unsafeDupablePerformIO (PQ.ftable result column
229 then Nothing
250 then Nothing
230 else Just x
251 else Just x
232−-- | 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
233−-- 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
234−-- to libpq's @PQftablecol@.
257+-- protocol. Analogous to libpq's @PQftablecol@.
236tableColumn :: Field -> Int
259tableColumn :: Field -> Int
237tableColumn Field{..} = fromCol (unsafeDupablePerformIO (PQ.ftablecol result column))
260tableColumn Field{..} = fromCol (unsafeDupablePerformIO (PQ.ftablecol result column))
@@ -247,16 +270,33 @@ format Field{..} = unsafeDupablePerformIO (PQ.fformat result column)
248instance FromField () where
271instance FromField () where
249 fromField f _bs
272 fromField f _bs
250− | typeOid f /= $(inlineTypoid TI.void) = returnError Incompatible f ""
273+ | typeOid f /= TI.voidOid = returnError Incompatible f ""
251 | 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
253-- | For dealing with null values. Compatible with any postgresql type
282-- | For dealing with null values. Compatible with any postgresql type
254-- 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
255-- 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
256-- behavior.
285-- behavior.
257−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 =
258− fromField _ Nothing = pure Nothing
297+ Nothing -> pure Nothing
259− fromField f bs = Just <$> fromField f bs
298+ Just _ -> Just <$> p f mv
299+{-# INLINE optionalField #-}
261-- | compatible with any data type, but the value must be null
301-- | compatible with any data type, but the value must be null
262instance FromField Null where
302instance FromField Null where
@@ -266,30 +306,30 @@ instance FromField Null where
267instance FromField Bool where
307instance FromField Bool where
268 fromField f bs
308 fromField f bs
269− | typeOid f /= $(inlineTypoid TI.bool) = returnError Incompatible f ""
309+ | typeOid f /= TI.boolOid = returnError Incompatible f ""
270 | bs == Nothing = returnError UnexpectedNull f ""
310 | bs == Nothing = returnError UnexpectedNull f ""
271 | bs == Just "t" = pure True
311 | bs == Just "t" = pure True
272 | bs == Just "f" = pure False
312 | bs == Just "f" = pure False
273 | otherwise = returnError ConversionFailed f ""
313 | otherwise = returnError ConversionFailed f ""
275−-- | \"char\"
315+-- | \"char\", bpchar
276instance FromField Char where
316instance FromField Char where
277− fromField f bs =
317+ fromField f bs0 =
278− if typeOid f /= $(inlineTypoid TI.char)
318+ if (eq TI.charOid \/ eq TI.bpcharOid) (typeOid f)
279− then returnError Incompatible f ""
280− else case bs of
319+ then case bs0 of
281 Nothing -> returnError UnexpectedNull f ""
320 Nothing -> returnError UnexpectedNull f ""
282 Just bs -> if B.length bs /= 1
321 Just bs -> if B.length bs /= 1
283 then returnError ConversionFailed f "length not 1"
322 then returnError ConversionFailed f "length not 1"
284 else return $! (B.head bs)
323 else return $! (B.head bs)
324+ else returnError Incompatible f ""
287instance FromField Int16 where
327instance FromField Int16 where
288− fromField = atto ok16 $ signed decimal
328+ fromField = attoFieldParser ok16 $ signed decimal
290-- | int2, int4
330-- | int2, int4
291instance FromField Int32 where
331instance FromField Int32 where
292− fromField = atto ok32 $ signed decimal
332+ fromField = attoFieldParser ok32 $ signed decimal
294#if WORD_SIZE_IN_BITS < 64
334#if WORD_SIZE_IN_BITS < 64
295-- | 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.
@@ -299,50 +339,64 @@ instance FromField Int32 where
299-- This library was compiled as 64-bit code.
339-- This library was compiled as 64-bit code.
301instance FromField Int where
341instance FromField Int where
302− fromField = atto okInt $ signed decimal
342+ fromField = attoFieldParser okInt $ signed decimal
304-- | int2, int4, int8
344-- | int2, int4, int8
305instance FromField Int64 where
345instance FromField Int64 where
306− fromField = atto ok64 $ signed decimal
346+ fromField = attoFieldParser ok64 $ signed decimal
308-- | int2, int4, int8
348-- | int2, int4, int8
309instance FromField Integer where
349instance FromField Integer where
310− fromField = atto ok64 $ signed decimal
350+ fromField = attoFieldParser ok64 $ signed decimal
312-- | int2, float4 (Uses attoparsec's 'double' routine, for
352-- | int2, float4 (Uses attoparsec's 'double' routine, for
313-- better accuracy convert to 'Scientific' or 'Rational' first)
353-- better accuracy convert to 'Scientific' or 'Rational' first)
314instance FromField Float where
354instance FromField Float where
315− fromField = atto ok (realToFrac <$> double)
355+ fromField = attoFieldParser ok (realToFrac <$> pg_double)
316− where ok = $(mkCompats [TI.float4,TI.int2])
356+ where ok = eq TI.float4Oid \/ eq TI.int2Oid
318-- | int2, int4, float4, float8 (Uses attoparsec's 'double' routine, for
358-- | int2, int4, float4, float8 (Uses attoparsec's 'double' routine, for
319-- better accuracy convert to 'Scientific' or 'Rational' first)
359-- better accuracy convert to 'Scientific' or 'Rational' first)
320instance FromField Double where
360instance FromField Double where
321− fromField = atto ok double
361+ fromField = attoFieldParser ok pg_double
322− 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
324−-- | int2, int4, float4, float8, numeric
364+-- | int2, int4, int8, float4, float8, numeric
325instance FromField (Ratio Integer) where
365instance FromField (Ratio Integer) where
326− fromField = atto ok rational
366+ fromField = attoFieldParser ok pg_rational
327− 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
329−-- | int2, int4, float4, float8, numeric
369+-- | int2, int4, int8, float4, float8, numeric
330instance FromField Scientific where
370instance FromField Scientific where
331− fromField = atto ok rational
371+ fromField = attoFieldParser ok rational
332− 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
334unBinary :: Binary t -> t
374unBinary :: Binary t -> t
335unBinary (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))
337-- | bytea, name, text, \"char\", bpchar, varchar, unknown
391-- | bytea, name, text, \"char\", bpchar, varchar, unknown
338instance FromField SB.ByteString where
392instance FromField SB.ByteString where
339− fromField f dat = if typeOid f == $(inlineTypoid TI.bytea)
393+ fromField f dat = if typeOid f == TI.byteaOid
340 then unBinary <$> fromField f dat
394 then unBinary <$> fromField f dat
341 else doFromField f okText' pure dat
395 else doFromField f okText' pure dat
344instance FromField PQ.Oid where
398instance FromField PQ.Oid where
345− fromField f dat = PQ.Oid <$> atto (== $(inlineTypoid TI.oid)) decimal f dat
399+ fromField f dat = PQ.Oid <$> attoFieldParser (== TI.oidOid) decimal f dat
347-- | bytea, name, text, \"char\", bpchar, varchar, unknown
401-- | bytea, name, text, \"char\", bpchar, varchar, unknown
348instance FromField LB.ByteString where
402instance FromField LB.ByteString where
@@ -350,7 +404,7 @@ instance FromField LB.ByteString where
351unescapeBytea :: Field -> SB.ByteString
405unescapeBytea :: Field -> SB.ByteString
352 -> Conversion (Binary SB.ByteString)
406 -> Conversion (Binary SB.ByteString)
353−unescapeBytea f str = case unsafeDupablePerformIO (PQ.unescapeBytea str) of
407+unescapeBytea f str' = case unsafeDupablePerformIO (PQ.unescapeBytea str') of
354 Nothing -> returnError ConversionFailed f "unescapeBytea failed"
408 Nothing -> returnError ConversionFailed f "unescapeBytea failed"
355 Just str -> pure (Binary str)
409 Just str -> pure (Binary str)
@@ -373,54 +427,85 @@ instance FromField ST.Text where
373instance FromField LT.Text where
427instance FromField LT.Text where
374 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)
376-- | name, text, \"char\", bpchar, varchar
452-- | name, text, \"char\", bpchar, varchar
377instance FromField [Char] where
453instance FromField [Char] where
378 fromField f dat = ST.unpack <$> fromField f dat
454 fromField f dat = ST.unpack <$> fromField f dat
380-- | timestamptz
456-- | timestamptz
381instance FromField UTCTime where
457instance FromField UTCTime where
382− fromField = ff $(inlineTypoid TI.timestamptz) "UTCTime" parseUTCTime
458+ fromField = ff TI.timestamptzOid "UTCTime" parseUTCTime
384-- | timestamptz
460-- | timestamptz
385instance FromField ZonedTime where
461instance FromField ZonedTime where
386− fromField = ff $(inlineTypoid TI.timestamptz) "ZonedTime" parseZonedTime
462+ fromField = ff TI.timestamptzOid "ZonedTime" parseZonedTime
388-- | timestamp
464-- | timestamp
389instance FromField LocalTime where
465instance FromField LocalTime where
390− fromField = ff $(inlineTypoid TI.timestamp) "LocalTime" parseLocalTime
466+ fromField = ff TI.timestampOid "LocalTime" parseLocalTime
393instance FromField Day where
469instance FromField Day where
394− fromField = ff $(inlineTypoid TI.date) "Day" parseDay
470+ fromField = ff TI.dateOid "Day" parseDay
397instance FromField TimeOfDay where
473instance FromField TimeOfDay where
398− fromField = ff $(inlineTypoid TI.time) "TimeOfDay" parseTimeOfDay
474+ fromField = ff TI.timeOid "TimeOfDay" parseTimeOfDay
400-- | timestamptz
476-- | timestamptz
401instance FromField UTCTimestamp where
477instance FromField UTCTimestamp where
402− fromField = ff $(inlineTypoid TI.timestamptz) "UTCTimestamp" parseUTCTimestamp
478+ fromField = ff TI.timestamptzOid "UTCTimestamp" parseUTCTimestamp
404-- | timestamptz
480-- | timestamptz
405instance FromField ZonedTimestamp where
481instance FromField ZonedTimestamp where
406− fromField = ff $(inlineTypoid TI.timestamptz) "ZonedTimestamp" parseZonedTimestamp
482+ fromField = ff TI.timestamptzOid "ZonedTimestamp" parseZonedTimestamp
408-- | timestamp
484-- | timestamp
409instance FromField LocalTimestamp where
485instance FromField LocalTimestamp where
410− fromField = ff $(inlineTypoid TI.timestamp) "LocalTimestamp" parseLocalTimestamp
486+ fromField = ff TI.timestampOid "LocalTimestamp" parseLocalTimestamp
413instance FromField Date where
489instance FromField Date where
414− 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
416ff :: PQ.Oid -> String -> (B8.ByteString -> Either String a)
501ff :: PQ.Oid -> String -> (B8.ByteString -> Either String a)
417 -> Field -> Maybe B8.ByteString -> Conversion a
502 -> Field -> Maybe B8.ByteString -> Conversion a
418−ff compatOid hsType parse f mstr =
503+ff compatOid hsType parseBS f mstr =
419 if typeOid f /= compatOid
504 if typeOid f /= compatOid
420 then err Incompatible ""
505 then err Incompatible ""
421 else case mstr of
506 else case mstr of
422 Nothing -> err UnexpectedNull ""
507 Nothing -> err UnexpectedNull ""
423− Just str -> case parse str of
508+ Just str -> case parseBS str of
424 Left msg -> err ConversionFailed msg
509 Left msg -> err ConversionFailed msg
425 Right val -> return val
510 Right val -> return val
@@ -442,27 +527,29 @@ instance (FromField a, FromField b) => FromField (Either a b) where
443-- | any postgresql array whose elements are compatible with type @a@
528-- | any postgresql array whose elements are compatible with type @a@
444instance (FromField a, Typeable a) => FromField (PGArray a) where
529instance (FromField a, Typeable a) => FromField (PGArray a) where
445− fromField f mdat = do
530+ fromField = pgArrayFieldParser fromField
532+pgArrayFieldParser :: Typeable a => FieldParser a -> FieldParser (PGArray a)
533+pgArrayFieldParser fieldParser f mdat = do
446 info <- typeInfo f
534 info <- typeInfo f
447 case info of
535 case info of
448 TI.Array{} ->
536 TI.Array{} ->
449 case mdat of
537 case mdat of
450 Nothing -> returnError UnexpectedNull f ""
538 Nothing -> returnError UnexpectedNull f ""
451 Just dat -> do
539 Just dat -> do
452− case parseOnly (fromArray info f) dat of
540+ case parseOnly (fromArray fieldParser info f) dat of
453 Left err -> returnError ConversionFailed f err
541 Left err -> returnError ConversionFailed f err
454 Right conv -> PGArray <$> conv
542 Right conv -> PGArray <$> conv
455 _ -> returnError Incompatible f ""
543 _ -> returnError Incompatible f ""
457−fromArray :: (FromField a)
458− => TypeInfo -> Field -> Parser (Conversion [a])
545+fromArray :: FieldParser a -> TypeInfo -> Field -> Parser (Conversion [a])
459−fromArray typeInfo f = sequence . (parseIt <$>) <$> array delim
546+fromArray fieldParser typInfo f = sequence . (parseIt <$>) <$> array delim
461− delim = typdelim (typelem typeInfo)
548+ delim = typdelim (typelem typInfo)
462− fElem = f{ typeOid = typoid (typelem typeInfo) }
549+ fElem = f{ typeOid = typoid (typelem typInfo) }
464 parseIt item =
551 parseIt item =
465− fromField f' $ if item' == "NULL" then Nothing else Just item'
552+ fieldParser f' $ if item == Arrays.Plain "NULL" then Nothing else Just item'
467 item' = fmt delim item
554 item' = fmt delim item
468 f' | Arrays.Array _ <- item = f
555 f' | Arrays.Array _ <- item = f
@@ -477,7 +564,7 @@ instance (FromField a, Typeable a) => FromField (IOVector a) where
478instance FromField UUID where
565instance FromField UUID where
479 fromField f mbs =
566 fromField f mbs =
480− if typeOid f /= $(inlineTypoid TI.uuid)
567+ if typeOid f /= TI.uuidOid
481 then returnError Incompatible f ""
568 then returnError Incompatible f ""
482 else case mbs of
569 else case mbs of
483 Nothing -> returnError UnexpectedNull f ""
570 Nothing -> returnError UnexpectedNull f ""
@@ -486,26 +573,26 @@ instance FromField UUID where
486 Nothing -> returnError ConversionFailed f "Invalid UUID"
573 Nothing -> returnError ConversionFailed f "Invalid UUID"
487 Just uuid -> pure uuid
574 Just uuid -> pure uuid
489−-- | json
576+-- | json, jsonb
490instance FromField JSON.Value where
577instance FromField JSON.Value where
491− fromField f mbs =
578+ fromField f mbs = parseBS =<< fromFieldJSONByteString f mbs
492− if typeOid f /= $(inlineTypoid TI.json)
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 =
588+ if typeOid f /= TI.jsonOid && typeOid f /= TI.jsonbOid
493 then returnError Incompatible f ""
589 then returnError Incompatible f ""
494 else case mbs of
590 else case mbs of
495 Nothing -> returnError UnexpectedNull f ""
591 Nothing -> returnError UnexpectedNull f ""
496− Just bs ->
592+ Just bs -> pure bs
497−#if MIN_VERSION_aeson(0,6,3)
498− case JSON.eitherDecodeStrict' bs of
499−#elif MIN_VERSION_bytestring(0,10,0)
500− case JSON.eitherDecode' $ LB.fromStrict bs of
502− case JSON.eitherDecode' $ LB.fromChunks [bs] of
504− Left err -> returnError ConversionFailed f err
505− Right val -> pure val
507-- | 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
508−-- Haskell value using 'JSON.fromJSON'.
595+-- Haskell value using the 'JSON.FromJSON' instance.
510-- This can be used as the default implementation for the 'fromField'
597-- This can be used as the default implementation for the 'fromField'
511-- method for Haskell types that have a JSON representation in
598-- method for Haskell types that have a JSON representation in
@@ -513,14 +600,23 @@ instance FromField JSON.Value where
514-- The 'Typeable' constraint is required to show more informative
601-- The 'Typeable' constraint is required to show more informative
515-- 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@
516fromJSONField :: (JSON.FromJSON a, Typeable a) => FieldParser a
613fromJSONField :: (JSON.FromJSON a, Typeable a) => FieldParser a
517fromJSONField f mbBs = do
614fromJSONField f mbBs = do
518 value <- fromField f mbBs
615 value <- fromField f mbBs
519− case JSON.fromJSON value of
616+ case JSON.ifromJSON value of
520− JSON.Error err -> returnError ConversionFailed f $
617+ JSON.IError path err -> returnError ConversionFailed f $
521− "JSON decoding error: " ++ err
618+ "JSON decoding error: " ++ (JSON.formatError path err)
522− JSON.Success x -> pure x
619+ JSON.ISuccess x -> pure x
525-- | Compatible with the same set of types as @a@. Note that
621-- | Compatible with the same set of types as @a@. Note that
526-- modifying the 'IORef' does not have any effects outside
622-- modifying the 'IORef' does not have any effects outside
@@ -537,20 +633,33 @@ instance FromField a => FromField (MVar a) where
537type Compat = PQ.Oid -> Bool
633type Compat = PQ.Oid -> Bool
539okText, okText', okBinary, ok16, ok32, ok64, okInt :: Compat
635okText, okText', okBinary, ok16, ok32, ok64, okInt :: Compat
540−okText = $( mkCompats [ TI.name, TI.text, TI.char,
636+okText = eq TI.nameOid \/ eq TI.textOid \/ eq TI.charOid
541− TI.bpchar, TI.varchar ] )
637+ \/ eq TI.bpcharOid \/ eq TI.varcharOid
542−okText' = $( mkCompats [ TI.name, TI.text, TI.char,
638+okText' = eq TI.nameOid \/ eq TI.textOid \/ eq TI.charOid
543− TI.bpchar, TI.varchar, TI.unknown ] )
639+ \/ eq TI.bpcharOid \/ eq TI.varcharOid \/ eq TI.unknownOid
544−okBinary = (== $( inlineTypoid TI.bytea ))
640+okBinary = eq TI.byteaOid
545−ok16 = (== $( inlineTypoid TI.int2 ))
641+ok16 = eq TI.int2Oid
546−ok32 = $( mkCompats [TI.int2,TI.int4] )
642+ok32 = eq TI.int2Oid \/ eq TI.int4Oid
547−ok64 = $( mkCompats [TI.int2,TI.int4,TI.int8] )
643+ok64 = eq TI.int2Oid \/ eq TI.int4Oid \/ eq TI.int8Oid
548#if WORD_SIZE_IN_BITS < 64
644#if WORD_SIZE_IN_BITS < 64
549okInt = ok32
645okInt = ok32
551okInt = 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
554doFromField :: forall a . (Typeable a)
663doFromField :: forall a . (Typeable a)
555 => Field -> Compat -> (ByteString -> Conversion a)
664 => Field -> Compat -> (ByteString -> Conversion a)
556 -> Maybe ByteString -> Conversion a
665 -> Maybe ByteString -> Conversion a
@@ -575,10 +684,22 @@ returnError mkErr f msg = do
575 (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)
578−atto :: forall a. (Typeable a)
696+attoFieldParser :: forall a. (Typeable a)
579− => Compat -> Parser a -> Field -> Maybe ByteString
697+ => (PQ.Oid -> Bool)
580− -> Conversion a
698+ -- ^ Predicate for whether the postgresql type oid is compatible with this parser
700+ -- ^ An attoparsec parser.
581−atto types p0 f dat = doFromField f types (go p0) dat
702+attoFieldParser types p0 f dat = doFromField f types (go p0) dat
583 go :: Parser a -> ByteString -> Conversion a
704 go :: Parser a -> ByteString -> Conversion a