@@ -1,8 +1,7 @@
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 #-}
4+{-# LANGUAGE RecordWildCards, TemplateHaskell #-}
5−{-# LANGUAGE PolyKinds #-}
8Module: Database.PostgreSQL.Simple.FromField
7Module: Database.PostgreSQL.Simple.FromField
@@ -24,24 +23,6 @@ the Haskell 'Double' type is compatible with the PostgreSQL's 32-bit
24since a 'Double' might lose precision if representing PostgreSQL's 64-bit
23since a 'Double' might lose precision if representing PostgreSQL's 64-bit
25@bigint@, the two are /not/ considered compatible.
24@bigint@, the two are /not/ considered compatible.
27−Note that the 'Float' and 'Double' instances use attoparsec's 'double'
28−conversion routine, which sacrifices some accuracy for speed. If you
29−need accuracy, consider first converting data to a 'Scientific' or 'Rational'
30−type, and then converting to a floating-point type. If you are defining
31−your own 'Database.PostgreSQL.Simple.FromRow.FromRow' instances, this can be
33−@'fromRational' '<$>' 'Database.PostgreSQL.Simple.FromRow.field'@, although
34−this idiom is additionally compatible with PostgreSQL's @int8@ and @numeric@
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'.
45Because 'FromField' is a typeclass, one may provide conversions to
26Because 'FromField' is a typeclass, one may provide conversions to
46additional Haskell types without modifying postgresql-simple. This is
27additional Haskell types without modifying postgresql-simple. This is
47particularly useful for supporting PostgreSQL types that postgresql-simple
28particularly useful for supporting PostgreSQL types that postgresql-simple
@@ -106,38 +87,32 @@ module Database.PostgreSQL.Simple.FromField
106 , typeOid
87 , typeOid
107 , PQ.Oid(..)
88 , PQ.Oid(..)
108 , PQ.Format(..)
89 , PQ.Format(..)
109− , pgArrayFieldParser
113 , fromJSONField
91 , fromJSONField
114− , fromFieldJSONByteString
117#include "MachDeps.h"
94#include "MachDeps.h"
119−import Control.Applicative ( Const(Const), (<|>), (<$>), pure, (*>), (<*) )
96+import Control.Applicative
120−import Control.Concurrent.MVar (MVar, newMVar)
97+ ( Applicative, (<|>), (<$>), pure )
121−import Control.Exception (Exception (toException, fromException))
98+import Control.Exception (Exception)
122import qualified Data.Aeson as JSON
99import qualified Data.Aeson as JSON
123−import Data.Attoparsec.ByteString.Char8 hiding (Result)
100+import Data.Attoparsec.Char8 hiding (Result)
124import Data.ByteString (ByteString)
101import Data.ByteString (ByteString)
125import qualified Data.ByteString.Char8 as B
102import qualified Data.ByteString.Char8 as B
126−import Data.Functor.Identity (Identity(Identity))
127import Data.Int (Int16, Int32, Int64)
103import Data.Int (Int16, Int32, Int64)
128−import Data.IORef (IORef, newIORef)
129import Data.Ratio (Ratio)
104import Data.Ratio (Ratio)
130−import Data.Time.Compat ( UTCTime, ZonedTime, LocalTime, Day, TimeOfDay, CalendarDiffTime )
105+import Data.Time ( UTCTime, ZonedTime, LocalTime, Day, TimeOfDay )
131import Data.Typeable (Typeable, typeOf)
106import Data.Typeable (Typeable, typeOf)
132import Data.Vector (Vector)
107import Data.Vector (Vector)
133−import Data.Vector.Mutable (IOVector)
134import qualified Data.Vector as V
108import qualified Data.Vector as V
135import Database.PostgreSQL.Simple.Internal
109import Database.PostgreSQL.Simple.Internal
136import Database.PostgreSQL.Simple.Compat
110import Database.PostgreSQL.Simple.Compat
137import Database.PostgreSQL.Simple.Ok
111import Database.PostgreSQL.Simple.Ok
138−import Database.PostgreSQL.Simple.Types
112+import Database.PostgreSQL.Simple.Types (Binary(..), Null(..))
139import Database.PostgreSQL.Simple.TypeInfo as TI
113import Database.PostgreSQL.Simple.TypeInfo as TI
140import qualified Database.PostgreSQL.Simple.TypeInfo.Static as TI
114import qualified Database.PostgreSQL.Simple.TypeInfo.Static as TI
115+import Database.PostgreSQL.Simple.TypeInfo.Macro as TI
141import Database.PostgreSQL.Simple.Time
116import Database.PostgreSQL.Simple.Time
142import Database.PostgreSQL.Simple.Arrays as Arrays
117import Database.PostgreSQL.Simple.Arrays as Arrays
143import qualified Database.PostgreSQL.LibPQ as PQ
118import qualified Database.PostgreSQL.LibPQ as PQ
@@ -147,14 +122,8 @@ import qualified Data.ByteString.Lazy as LB
147import qualified Data.Text as ST
122import qualified Data.Text as ST
148import qualified Data.Text.Encoding as ST
123import qualified Data.Text.Encoding as ST
149import qualified Data.Text.Lazy as LT
124import qualified Data.Text.Lazy as LT
150−import Data.CaseInsensitive (CI)
125+import Data.UUID (UUID)
151−import qualified Data.CaseInsensitive as CI
152−import Data.UUID.Types (UUID)
153−import qualified Data.UUID.Types as UUID
126+import qualified Data.UUID as UUID
154−import Data.Scientific (Scientific)
155−import GHC.Real (infinity, notANumber)
157−import qualified Data.Aeson.Types as JSON
159-- | Exception thrown if conversion from a SQL value to a Haskell
128-- | Exception thrown if conversion from a SQL value to a Haskell
160-- value fails.
129-- value fails.
@@ -182,9 +151,7 @@ data ResultError = Incompatible { errSQLType :: String
182 -- between metadata and actual data in a row).
151 -- between metadata and actual data in a row).
183 deriving (Eq, Show, Typeable)
152 deriving (Eq, Show, Typeable)
185−instance Exception ResultError where
154+instance Exception ResultError
186− toException = postgresqlExceptionToException
187− fromException = postgresqlExceptionFromException
189left :: Exception a => a -> Conversion b
156left :: Exception a => a -> Conversion b
190left = conversionError
157left = conversionError
@@ -200,15 +167,16 @@ class FromField a where
200 -- library instances, this will usually be a single 'ResultError', but
167 -- library instances, this will usually be a single 'ResultError', but
201 -- may be a 'UnicodeException'.
168 -- may be a 'UnicodeException'.
203− -- Note that retaining any reference to the 'Field' argument causes
170+ -- Note that retaining any reference to the 'Field' or 'ByteString'
204− -- the entire @LibPQ.'PQ.Result'@ to be retained. Thus, implementations
171+ -- arguments causes the entire @LibPQ.'PQ.Result'@ to be retained.
205− -- of 'fromField' should return results that do not refer to this value
172+ -- Thus, as a rule of thumb, implementations of 'fromField' should
206− -- after the result have been evaluated to WHNF.
173+ -- not refer to these values after the result has been evaluated
174+ -- to WHNF. But it can be profitable to break this rule when you
175+ -- know it won't cause memory management problems.
208− -- Note that as of @postgresql-simple-0.4.0.0@, the 'ByteString' value
177+ -- The instances included with postgresql-simple follow this rule
209− -- has already been copied out of the @LibPQ.'PQ.Result'@ before it has
178+ -- of thumb (modulo bugs). For example, the instance for 'ByteString'
210− -- been passed to 'fromField'. This is because for short strings, it's
179+ -- uses 'B.copy' to avoid such a reference.
211− -- cheaper to copy the string than to set up a finalizer.
213-- | Returns the data type name. This is the preferred way of identifying
181-- | Returns the data type name. This is the preferred way of identifying
214-- types that do not have a stable type oid, such as types provided by
182-- types that do not have a stable type oid, such as types provided by
@@ -225,7 +193,7 @@ typename field = typname <$> typeInfo field
226typeInfo :: Field -> Conversion TypeInfo
194typeInfo :: Field -> Conversion TypeInfo
227typeInfo Field{..} = Conversion $ \conn -> do
195typeInfo Field{..} = Conversion $ \conn -> do
228− Ok <$> (getTypeInfo conn typeOid)
196+ Ok <$> (getTypeInfo conn =<< PQ.ftype result column)
230typeInfoByOid :: PQ.Oid -> Conversion TypeInfo
198typeInfoByOid :: PQ.Oid -> Conversion TypeInfo
231typeInfoByOid oid = Conversion $ \conn -> do
199typeInfoByOid oid = Conversion $ \conn -> do
@@ -250,11 +218,9 @@ tableOid Field{..} = toMaybeOid (unsafeDupablePerformIO (PQ.ftable result column
250 then Nothing
218 then Nothing
251 else Just x
219 else Just x
253−-- | If the column has a table associated with it, this returns the
221+-- | If the column has a table associated with it, this returns the number
254−-- number of the associated table column. Table columns have
222+-- off the associated table column. Numbering starts from 0. Analogous
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
257−-- protocol. Analogous to libpq's @PQftablecol@.
223+-- to libpq's @PQftablecol@.
259tableColumn :: Field -> Int
225tableColumn :: Field -> Int
260tableColumn Field{..} = fromCol (unsafeDupablePerformIO (PQ.ftablecol result column))
226tableColumn Field{..} = fromCol (unsafeDupablePerformIO (PQ.ftablecol result column))
@@ -270,33 +236,16 @@ format Field{..} = unsafeDupablePerformIO (PQ.fformat result column)
271instance FromField () where
237instance FromField () where
272 fromField f _bs
238 fromField f _bs
273− | typeOid f /= TI.voidOid = returnError Incompatible f ""
239+ | typeOid f /= $(inlineTypoid TI.void) = returnError Incompatible f ""
274 | otherwise = pure ()
240 | 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
282-- | For dealing with null values. Compatible with any postgresql type
242-- | For dealing with null values. Compatible with any postgresql type
283-- compatible with type @a@. Note that the type is not checked if
243-- compatible with type @a@. Note that the type is not checked if
284-- the value is null, although it is inadvisable to rely on this
244-- the value is null, although it is inadvisable to rely on this
285-- behavior.
245-- behavior.
286−instance FromField a => FromField (Maybe a) where
246+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 =
297− Nothing -> pure Nothing
247+ fromField _ Nothing = pure Nothing
298− Just _ -> Just <$> p f mv
248+ fromField f bs = Just <$> fromField f bs
299−{-# INLINE optionalField #-}
301-- | compatible with any data type, but the value must be null
250-- | compatible with any data type, but the value must be null
302instance FromField Null where
251instance FromField Null where
@@ -306,30 +255,30 @@ instance FromField Null where
307instance FromField Bool where
256instance FromField Bool where
308 fromField f bs
257 fromField f bs
309− | typeOid f /= TI.boolOid = returnError Incompatible f ""
258+ | typeOid f /= $(inlineTypoid TI.bool) = returnError Incompatible f ""
310 | bs == Nothing = returnError UnexpectedNull f ""
259 | bs == Nothing = returnError UnexpectedNull f ""
311 | bs == Just "t" = pure True
260 | bs == Just "t" = pure True
312 | bs == Just "f" = pure False
261 | bs == Just "f" = pure False
313 | otherwise = returnError ConversionFailed f ""
262 | otherwise = returnError ConversionFailed f ""
315−-- | \"char\", bpchar
264+-- | \"char\"
316instance FromField Char where
265instance FromField Char where
317− fromField f bs0 =
266+ fromField f bs =
318− if (eq TI.charOid \/ eq TI.bpcharOid) (typeOid f)
267+ if typeOid f /= $(inlineTypoid TI.char)
268+ then returnError Incompatible f ""
319− then case bs0 of
269+ else case bs of
320 Nothing -> returnError UnexpectedNull f ""
270 Nothing -> returnError UnexpectedNull f ""
321 Just bs -> if B.length bs /= 1
271 Just bs -> if B.length bs /= 1
322 then returnError ConversionFailed f "length not 1"
272 then returnError ConversionFailed f "length not 1"
323 else return $! (B.head bs)
273 else return $! (B.head bs)
324− else returnError Incompatible f ""
327instance FromField Int16 where
276instance FromField Int16 where
328− fromField = attoFieldParser ok16 $ signed decimal
277+ fromField = atto ok16 $ signed decimal
330-- | int2, int4
279-- | int2, int4
331instance FromField Int32 where
280instance FromField Int32 where
332− fromField = attoFieldParser ok32 $ signed decimal
281+ fromField = atto ok32 $ signed decimal
334#if WORD_SIZE_IN_BITS < 64
283#if WORD_SIZE_IN_BITS < 64
335-- | int2, int4, and if compiled as 64-bit code, int8 as well.
284-- | int2, int4, and if compiled as 64-bit code, int8 as well.
@@ -339,64 +288,43 @@ instance FromField Int32 where
339-- This library was compiled as 64-bit code.
288-- This library was compiled as 64-bit code.
341instance FromField Int where
290instance FromField Int where
342− fromField = attoFieldParser okInt $ signed decimal
291+ fromField = atto okInt $ signed decimal
344-- | int2, int4, int8
293-- | int2, int4, int8
345instance FromField Int64 where
294instance FromField Int64 where
346− fromField = attoFieldParser ok64 $ signed decimal
295+ fromField = atto ok64 $ signed decimal
348-- | int2, int4, int8
297-- | int2, int4, int8
349instance FromField Integer where
298instance FromField Integer where
350− fromField = attoFieldParser ok64 $ signed decimal
299+ fromField = atto ok64 $ signed decimal
352−-- | int2, float4 (Uses attoparsec's 'double' routine, for
301+-- | int2, float4
353−-- better accuracy convert to 'Scientific' or 'Rational' first)
354instance FromField Float where
302instance FromField Float where
355− fromField = attoFieldParser ok (realToFrac <$> pg_double)
303+ fromField = atto ok (realToFrac <$> double)
356− where ok = eq TI.float4Oid \/ eq TI.int2Oid
304+ where ok = $(mkCompats [TI.float4,TI.int2])
358−-- | int2, int4, float4, float8 (Uses attoparsec's 'double' routine, for
306+-- | int2, int4, float4, float8
359−-- better accuracy convert to 'Scientific' or 'Rational' first)
360instance FromField Double where
307instance FromField Double where
361− fromField = attoFieldParser ok pg_double
308+ fromField = atto ok double
362− where ok = eq TI.float4Oid \/ eq TI.float8Oid \/ eq TI.int2Oid \/ eq TI.int4Oid
309+ where ok = $(mkCompats [TI.float4,TI.float8,TI.int2,TI.int4])
364−-- | int2, int4, int8, float4, float8, numeric
311+-- | int2, int4, float4, float8, numeric
365instance FromField (Ratio Integer) where
312instance FromField (Ratio Integer) where
366− fromField = attoFieldParser ok pg_rational
313+ fromField = atto ok rational
367− where ok = eq TI.float4Oid \/ eq TI.float8Oid \/ eq TI.int2Oid \/ eq TI.int4Oid \/ eq TI.int8Oid \/ eq TI.numericOid
369−-- | int2, int4, int8, float4, float8, numeric
314+ where ok = $(mkCompats [TI.float4,TI.float8,TI.int2,TI.int4,TI.numeric])
370−instance FromField Scientific where
371− fromField = attoFieldParser ok rational
372− where ok = eq TI.float4Oid \/ eq TI.float8Oid \/ eq TI.int2Oid \/ eq TI.int4Oid \/ eq TI.int8Oid \/ eq TI.numericOid
374unBinary :: Binary t -> t
316unBinary :: Binary t -> t
375unBinary (Binary x) = x
317unBinary (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))
391-- | bytea, name, text, \"char\", bpchar, varchar, unknown
319-- | bytea, name, text, \"char\", bpchar, varchar, unknown
392instance FromField SB.ByteString where
320instance FromField SB.ByteString where
393− fromField f dat = if typeOid f == TI.byteaOid
321+ fromField f dat = if typeOid f == $(inlineTypoid TI.bytea)
394 then unBinary <$> fromField f dat
322 then unBinary <$> fromField f dat
395− else doFromField f okText' pure dat
323+ else doFromField f okText' (pure . B.copy) dat
398instance FromField PQ.Oid where
326instance FromField PQ.Oid where
399− fromField f dat = PQ.Oid <$> attoFieldParser (== TI.oidOid) decimal f dat
327+ fromField f dat = PQ.Oid <$> atto (== $(inlineTypoid TI.oid)) decimal f dat
401-- | bytea, name, text, \"char\", bpchar, varchar, unknown
329-- | bytea, name, text, \"char\", bpchar, varchar, unknown
402instance FromField LB.ByteString where
330instance FromField LB.ByteString where
@@ -404,7 +332,7 @@ instance FromField LB.ByteString where
405unescapeBytea :: Field -> SB.ByteString
333unescapeBytea :: Field -> SB.ByteString
406 -> Conversion (Binary SB.ByteString)
334 -> Conversion (Binary SB.ByteString)
407−unescapeBytea f str' = case unsafeDupablePerformIO (PQ.unescapeBytea str') of
335+unescapeBytea f str = case unsafeDupablePerformIO (PQ.unescapeBytea str) of
408 Nothing -> returnError ConversionFailed f "unescapeBytea failed"
336 Nothing -> returnError ConversionFailed f "unescapeBytea failed"
409 Just str -> pure (Binary str)
337 Just str -> pure (Binary str)
@@ -412,7 +340,7 @@ unescapeBytea f str' = case unsafeDupablePerformIO (PQ.unescapeBytea str') of
412instance FromField (Binary SB.ByteString) where
340instance FromField (Binary SB.ByteString) where
413 fromField f dat = case format f of
341 fromField f dat = case format f of
414 PQ.Text -> doFromField f okBinary (unescapeBytea f) dat
342 PQ.Text -> doFromField f okBinary (unescapeBytea f) dat
415− PQ.Binary -> doFromField f okBinary (pure . Binary) dat
343+ PQ.Binary -> doFromField f okBinary (pure . Binary . B.copy) dat
417-- | bytea
345-- | bytea
418instance FromField (Binary LB.ByteString) where
346instance FromField (Binary LB.ByteString) where
@@ -427,85 +355,54 @@ instance FromField ST.Text where
427instance FromField LT.Text where
355instance FromField LT.Text where
428 fromField f dat = LT.fromStrict <$> fromField f dat
356 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)
452-- | name, text, \"char\", bpchar, varchar
358-- | name, text, \"char\", bpchar, varchar
453instance FromField [Char] where
359instance FromField [Char] where
454 fromField f dat = ST.unpack <$> fromField f dat
360 fromField f dat = ST.unpack <$> fromField f dat
456-- | timestamptz
362-- | timestamptz
457instance FromField UTCTime where
363instance FromField UTCTime where
458− fromField = ff TI.timestamptzOid "UTCTime" parseUTCTime
364+ fromField = ff $(inlineTypoid TI.timestamptz) "UTCTime" parseUTCTime
460-- | timestamptz
366-- | timestamptz
461instance FromField ZonedTime where
367instance FromField ZonedTime where
462− fromField = ff TI.timestamptzOid "ZonedTime" parseZonedTime
368+ fromField = ff $(inlineTypoid TI.timestamptz) "ZonedTime" parseZonedTime
464-- | timestamp
370-- | timestamp
465instance FromField LocalTime where
371instance FromField LocalTime where
466− fromField = ff TI.timestampOid "LocalTime" parseLocalTime
372+ fromField = ff $(inlineTypoid TI.timestamp) "LocalTime" parseLocalTime
469instance FromField Day where
375instance FromField Day where
470− fromField = ff TI.dateOid "Day" parseDay
376+ fromField = ff $(inlineTypoid TI.date) "Day" parseDay
473instance FromField TimeOfDay where
379instance FromField TimeOfDay where
474− fromField = ff TI.timeOid "TimeOfDay" parseTimeOfDay
380+ fromField = ff $(inlineTypoid TI.time) "TimeOfDay" parseTimeOfDay
476-- | timestamptz
382-- | timestamptz
477instance FromField UTCTimestamp where
383instance FromField UTCTimestamp where
478− fromField = ff TI.timestamptzOid "UTCTimestamp" parseUTCTimestamp
384+ fromField = ff $(inlineTypoid TI.timestamptz) "UTCTimestamp" parseUTCTimestamp
480-- | timestamptz
386-- | timestamptz
481instance FromField ZonedTimestamp where
387instance FromField ZonedTimestamp where
482− fromField = ff TI.timestamptzOid "ZonedTimestamp" parseZonedTimestamp
388+ fromField = ff $(inlineTypoid TI.timestamptz) "ZonedTimestamp" parseZonedTimestamp
484-- | timestamp
390-- | timestamp
485instance FromField LocalTimestamp where
391instance FromField LocalTimestamp where
486− fromField = ff TI.timestampOid "LocalTimestamp" parseLocalTimestamp
392+ fromField = ff $(inlineTypoid TI.timestamp) "LocalTimestamp" parseLocalTimestamp
489instance FromField Date where
395instance FromField Date where
490− fromField = ff TI.dateOid "Date" parseDate
396+ fromField = ff $(inlineTypoid TI.date) "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
501ff :: PQ.Oid -> String -> (B8.ByteString -> Either String a)
398ff :: PQ.Oid -> String -> (B8.ByteString -> Either String a)
502 -> Field -> Maybe B8.ByteString -> Conversion a
399 -> Field -> Maybe B8.ByteString -> Conversion a
503−ff compatOid hsType parseBS f mstr =
400+ff compatOid hsType parse f mstr =
504 if typeOid f /= compatOid
401 if typeOid f /= compatOid
505 then err Incompatible ""
402 then err Incompatible ""
506 else case mstr of
403 else case mstr of
507 Nothing -> err UnexpectedNull ""
404 Nothing -> err UnexpectedNull ""
508− Just str -> case parseBS str of
405+ Just str -> case parse str of
509 Left msg -> err ConversionFailed msg
406 Left msg -> err ConversionFailed msg
510 Right val -> return val
407 Right val -> return val
@@ -526,45 +423,33 @@ instance (FromField a, FromField b) => FromField (Either a b) where
526 <|> (Left <$> fromField f dat)
423 <|> (Left <$> fromField f dat)
528-- | any postgresql array whose elements are compatible with type @a@
425-- | any postgresql array whose elements are compatible with type @a@
529−instance (FromField a, Typeable a) => FromField (PGArray a) where
426+instance (FromField a, Typeable a) => FromField (Vector a) where
530− fromField = pgArrayFieldParser fromField
427+ fromField f mdat = do
532−pgArrayFieldParser :: Typeable a => FieldParser a -> FieldParser (PGArray a)
533−pgArrayFieldParser fieldParser f mdat = do
534 info <- typeInfo f
428 info <- typeInfo f
535 case info of
429 case info of
536 TI.Array{} ->
430 TI.Array{} ->
537 case mdat of
431 case mdat of
538 Nothing -> returnError UnexpectedNull f ""
432 Nothing -> returnError UnexpectedNull f ""
539 Just dat -> do
433 Just dat -> do
540− case parseOnly (fromArray fieldParser info f) dat of
434+ case parseOnly (fromArray info f) dat of
541 Left err -> returnError ConversionFailed f err
435 Left err -> returnError ConversionFailed f err
542− Right conv -> PGArray <$> conv
436+ Right conv -> V.fromList <$> conv
543 _ -> returnError Incompatible f ""
437 _ -> returnError Incompatible f ""
439+fromArray :: (FromField a)
545−fromArray :: FieldParser a -> TypeInfo -> Field -> Parser (Conversion [a])
440+ => TypeInfo -> Field -> Parser (Conversion [a])
546−fromArray fieldParser typInfo f = sequence . (parseIt <$>) <$> array delim
441+fromArray typeInfo f = sequence . (parseIt <$>) <$> array delim
548− delim = typdelim (typelem typInfo)
443+ delim = typdelim (typelem typeInfo)
549− fElem = f{ typeOid = typoid (typelem typInfo) }
444+ fElem = f{ typeOid = typoid (typelem typeInfo) }
551− parseIt item =
445+ parseIt item = (fromField f' . Just . fmt delim) item
552− fieldParser f' $ if item == Arrays.Plain "NULL" then Nothing else Just item'
554− item' = fmt delim item
555− f' | Arrays.Array _ <- item = f
446+ where f' | Arrays.Array _ <- item = f
556− | otherwise = fElem
447+ | otherwise = fElem
558−instance (FromField a, Typeable a) => FromField (Vector a) where
559− fromField f v = V.fromList . fromPGArray <$> fromField f v
561−instance (FromField a, Typeable a) => FromField (IOVector a) where
562− fromField f v = liftConversion . V.unsafeThaw =<< fromField f v
565instance FromField UUID where
450instance FromField UUID where
566 fromField f mbs =
451 fromField f mbs =
567− if typeOid f /= TI.uuidOid
452+ if typeOid f /= $(inlineTypoid TI.uuid)
568 then returnError Incompatible f ""
453 then returnError Incompatible f ""
569 else case mbs of
454 else case mbs of
570 Nothing -> returnError UnexpectedNull f ""
455 Nothing -> returnError UnexpectedNull f ""
@@ -573,26 +458,20 @@ instance FromField UUID where
573 Nothing -> returnError ConversionFailed f "Invalid UUID"
458 Nothing -> returnError ConversionFailed f "Invalid UUID"
574 Just uuid -> pure uuid
459 Just uuid -> pure uuid
576−-- | json, jsonb
461+-- | json
577instance FromField JSON.Value where
462instance FromField JSON.Value where
578− fromField f mbs = parseBS =<< fromFieldJSONByteString f mbs
463+ fromField f mbs =
579− where parseBS bs = case JSON.eitherDecodeStrict' bs of
464+ if typeOid f /= $(inlineTypoid TI.json)
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
589 then returnError Incompatible f ""
465 then returnError Incompatible f ""
590 else case mbs of
466 else case mbs of
591 Nothing -> returnError UnexpectedNull f ""
467 Nothing -> returnError UnexpectedNull f ""
592− Just bs -> pure bs
468+ Just bs ->
469+ case JSON.eitherDecodeStrict' bs of
470+ Left err -> returnError ConversionFailed f err
471+ Right val -> pure val
594-- | Parse a field to a JSON 'JSON.Value' and convert that into a
473-- | Parse a field to a JSON 'JSON.Value' and convert that into a
595−-- Haskell value using the 'JSON.FromJSON' instance.
474+-- Haskell value using 'JSON.fromJSON'.
597-- This can be used as the default implementation for the 'fromField'
476-- This can be used as the default implementation for the 'fromField'
598-- method for Haskell types that have a JSON representation in
477-- method for Haskell types that have a JSON representation in
@@ -600,66 +479,31 @@ fromFieldJSONByteString f mbs =
601-- The 'Typeable' constraint is required to show more informative
480-- The 'Typeable' constraint is required to show more informative
602-- error messages when parsing fails.
481-- 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@
613fromJSONField :: (JSON.FromJSON a, Typeable a) => FieldParser a
482fromJSONField :: (JSON.FromJSON a, Typeable a) => FieldParser a
614fromJSONField f mbBs = do
483fromJSONField f mbBs = do
615 value <- fromField f mbBs
484 value <- fromField f mbBs
616− case JSON.ifromJSON value of
485+ case JSON.fromJSON value of
617− JSON.IError path err -> returnError ConversionFailed f $
486+ JSON.Error err -> returnError ConversionFailed f $
618− "JSON decoding error: " ++ (JSON.formatError path err)
487+ "JSON decoding error: " ++ err
619− JSON.ISuccess x -> pure x
488+ JSON.Success x -> pure x
621−-- | Compatible with the same set of types as @a@. Note that
622−-- modifying the 'IORef' does not have any effects outside
623−-- the local process on the local machine.
624−instance FromField a => FromField (IORef a) where
625− fromField f v = liftConversion . newIORef =<< fromField f v
627−-- | Compatible with the same set of types as @a@. Note that
628−-- modifying the 'MVar' does not have any effects outside
629−-- the local process on the local machine.
630−instance FromField a => FromField (MVar a) where
631− fromField f v = liftConversion . newMVar =<< fromField f v
633type Compat = PQ.Oid -> Bool
490type Compat = PQ.Oid -> Bool
635okText, okText', okBinary, ok16, ok32, ok64, okInt :: Compat
492okText, okText', okBinary, ok16, ok32, ok64, okInt :: Compat
636−okText = eq TI.nameOid \/ eq TI.textOid \/ eq TI.charOid
493+okText = $( mkCompats [ TI.name, TI.text, TI.char,
637− \/ eq TI.bpcharOid \/ eq TI.varcharOid
494+ TI.bpchar, TI.varchar ] )
638−okText' = eq TI.nameOid \/ eq TI.textOid \/ eq TI.charOid
495+okText' = $( mkCompats [ TI.name, TI.text, TI.char,
639− \/ eq TI.bpcharOid \/ eq TI.varcharOid \/ eq TI.unknownOid
496+ TI.bpchar, TI.varchar, TI.unknown ] )
640−okBinary = eq TI.byteaOid
497+okBinary = (== $( inlineTypoid TI.bytea ))
641−ok16 = eq TI.int2Oid
498+ok16 = (== $( inlineTypoid TI.int2 ))
642−ok32 = eq TI.int2Oid \/ eq TI.int4Oid
499+ok32 = $( mkCompats [TI.int2,TI.int4] )
643−ok64 = eq TI.int2Oid \/ eq TI.int4Oid \/ eq TI.int8Oid
500+ok64 = $( mkCompats [TI.int2,TI.int4,TI.int8] )
644#if WORD_SIZE_IN_BITS < 64
501#if WORD_SIZE_IN_BITS < 64
645okInt = ok32
502okInt = ok32
647okInt = ok64
504okInt = 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
663doFromField :: forall a . (Typeable a)
507doFromField :: forall a . (Typeable a)
664 => Field -> Compat -> (ByteString -> Conversion a)
508 => Field -> Compat -> (ByteString -> Conversion a)
665 -> Maybe ByteString -> Conversion a
509 -> Maybe ByteString -> Conversion a
@@ -684,22 +528,10 @@ returnError mkErr f msg = do
684 (show (typeOf (undefined :: a)))
528 (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)
696−attoFieldParser :: forall a. (Typeable a)
531+atto :: forall a. (Typeable a)
697− => (PQ.Oid -> Bool)
532+ => Compat -> Parser a -> Field -> Maybe ByteString
698− -- ^ Predicate for whether the postgresql type oid is compatible with this parser
533+ -> Conversion a
700− -- ^ An attoparsec parser.
702−attoFieldParser types p0 f dat = doFromField f types (go p0) dat
534+atto types p0 f dat = doFromField f types (go p0) dat
704 go :: Parser a -> ByteString -> Conversion a
536 go :: Parser a -> ByteString -> Conversion a