@@ -1,14 +1,18 @@
1−{-# LANGUAGE BangPatterns, DeriveDataTypeable, OverloadedStrings #-}
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE NamedFieldPuns #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PatternGuards #-}
2−{-# LANGUAGE DoAndIfThenElse, RecordWildCards, NamedFieldPuns #-}
5+{-# LANGUAGE RecordWildCards #-}
6+{-# LANGUAGE ViewPatterns #-}
3------------------------------------------------------------------------------
8------------------------------------------------------------------------------
5-- Module: Database.PostgreSQL.Simple
10-- Module: Database.PostgreSQL.Simple
6-- Copyright: (c) 2011 MailRank, Inc.
11-- Copyright: (c) 2011 MailRank, Inc.
7−-- (c) 2011 Leon P Smith
12+-- (c) 2011-2012 Leon P Smith
8-- License: BSD3
13-- License: BSD3
9-- Maintainer: Leon P Smith <leon@melding-monads.com>
14-- Maintainer: Leon P Smith <leon@melding-monads.com>
10-- Stability: experimental
15-- Stability: experimental
11−-- Portability: portable
13-- A mid-level client library for the PostgreSQL database, aimed at ease of
17-- A mid-level client library for the PostgreSQL database, aimed at ease of
14-- use and high performance.
18-- use and high performance.
@@ -38,6 +42,9 @@ module Database.PostgreSQL.Simple
38 -- ** Modifying multiple rows at once
42 -- ** Modifying multiple rows at once
45+ -- ** @RETURNING@: modifications that return results
41 -- * Extracting results
48 -- * Extracting results
42 -- $result
49 -- $result
@@ -48,33 +55,54 @@ module Database.PostgreSQL.Simple
50 -- * Types
57 -- * Types
52− , Connection
58+ Connection
55 , Binary(..)
63 , Binary(..)
56 , Only(..)
64 , Only(..)
57 -- ** Exceptions
66 -- ** Exceptions
67+ , SomePostgreSqlException(..)
58 , SqlError(..)
68 , SqlError(..)
59− , FormatError(fmtMessage, fmtQuery, fmtParams)
70+ , FormatError(..)
60− , QueryError(qeMessage, qeQuery)
71+ , QueryError(..)
61− , ResultError(errSQLType, errHaskellType, errMessage)
72+ , ResultError(..)
62 -- * Connection management
73 -- * Connection management
64 , Base.connectPostgreSQL
74 , Base.connectPostgreSQL
65− , Base.postgreSQLConnectionString
66− , Base.defaultConnectInfo
67 , Base.close
75 , Base.close
78+ , Base.ConnectInfo(..)
79+ , Base.defaultConnectInfo
80+ , Base.postgreSQLConnectionString
68 -- * Queries that return results
81 -- * Queries that return results
71−{--
84+ -- ** Queries taking parser as argument
72 -- * Queries that stream results
87 -- * Queries that stream results
76 , forEach_
96 , forEach_
98+ -- ** Queries that stream results taking a parser as an argument
100+ , foldWithOptionsAndParser
102+ , foldWithOptionsAndParser_
78 -- * Statements that do not return results
106 -- * Statements that do not return results
79 , execute
107 , execute
80 , execute_
108 , execute_
@@ -82,6 +110,7 @@ module Database.PostgreSQL.Simple
82-- , Base.insertID
110-- , Base.insertID
83 -- * Transaction handling
111 -- * Transaction handling
84 , withTransaction
112 , withTransaction
85-- , Base.autocommit
114-- , Base.autocommit
@@ -91,55 +120,27 @@ module Database.PostgreSQL.Simple
91 , formatQuery
120 , formatQuery
94−import Blaze.ByteString.Builder (Builder, fromByteString, toByteString)
123+import Data.ByteString.Builder (Builder, byteString, char8)
95−import Blaze.ByteString.Builder.Char8 (fromChar)
96−import Control.Applicative ((<$>), pure)
124+import Control.Applicative ((<$>))
97−import Control.Concurrent.MVar
98−import Control.Exception (Exception, bracket, onException, throw, throwIO)
125+import Control.Exception as E
99−import Control.Monad (forM)
100−import Control.Monad.Fix (fix)
101−import Data.ByteString (ByteString)
126+import Data.ByteString (ByteString)
102−-- import qualified Data.ByteString as B (unpack)
103−import Data.Char(ord)
104−import Data.Int (Int64)
127+import Data.Int (Int64)
105−import qualified Data.IntMap as IntMap
106−import Data.List (intersperse)
128+import Data.List (intersperse)
107−import Data.Monoid (mappend, mconcat)
129+import Data.Monoid (mconcat)
108−import Data.Typeable (Typeable)
130+import Database.PostgreSQL.Simple.Compat ((<>), toByteString)
109−--import Database.MySQL.Base (Connection, Result)
131+import Database.PostgreSQL.Simple.Cursor
110−--import Database.MySQL.Base.Types (Field)
132+import Database.PostgreSQL.Simple.FromField (ResultError(..))
111−import Database.PostgreSQL.Simple.BuiltinTypes (oid2builtin, builtin2typname)
133+import Database.PostgreSQL.Simple.FromRow (FromRow(..))
112−import Database.PostgreSQL.Simple.Param (Action(..), inQuotes)
134+import Database.PostgreSQL.Simple.ToField (Action(..))
113−import Database.PostgreSQL.Simple.QueryParams (QueryParams(..))
114−import Database.PostgreSQL.Simple.Result (ResultError(..))
135+import Database.PostgreSQL.Simple.ToRow (ToRow(..))
115−import Database.PostgreSQL.Simple.QueryResults (QueryResults(..))
136+import Database.PostgreSQL.Simple.Types
116−-- import Database.PostgreSQL.Simple.Result (ResultError(..))
117−import Database.PostgreSQL.Simple.Types (Binary(..), In(..), Only(..), Query(..))
137+ ( Binary(..), In(..), Only(..), Query(..), (:.)(..) )
118−import Database.PostgreSQL.Simple.Internal as Base
138+import Database.PostgreSQL.Simple.Internal as Base
139+import Database.PostgreSQL.Simple.Internal.PQResultUtils
140+import Database.PostgreSQL.Simple.Transaction
119import qualified Database.PostgreSQL.LibPQ as PQ
141import qualified Database.PostgreSQL.LibPQ as PQ
120−import Text.Regex.PCRE.Light (compile, caseless, match)
121import qualified Data.ByteString.Char8 as B
142import qualified Data.ByteString.Char8 as B
122−--import qualified Database.MySQL.Base as Base
124−-- | Exception thrown if a 'Query' could not be formatted correctly.
125−-- This may occur if the number of \'@?@\' characters in the query
126−-- string does not match the number of parameters provided.
127−data FormatError = FormatError {
128− fmtMessage :: String
130− , fmtParams :: [ByteString]
131− } deriving (Eq, Show, Typeable)
133−instance Exception FormatError
135−-- | Exception thrown if 'query' is used to perform an @INSERT@-like
136−-- operation, or 'execute' is used to perform a @SELECT@-like operation.
137−data QueryError = QueryError {
140− } deriving (Eq, Show, Typeable)
142−instance Exception QueryError
144-- | Format a query string.
145-- | Format a query string.
@@ -151,11 +152,11 @@ instance Exception QueryError
152-- Throws 'FormatError' if the query string could not be formatted
153-- Throws 'FormatError' if the query string could not be formatted
153-- correctly.
154-- correctly.
154−formatQuery :: QueryParams q => Connection -> Query -> q -> IO ByteString
155+formatQuery :: ToRow q => Connection -> Query -> q -> IO ByteString
155formatQuery conn q@(Query template) qs
156formatQuery conn q@(Query template) qs
156 | null xs && '?' `B.notElem` template = return template
157 | null xs && '?' `B.notElem` template = return template
157 | otherwise = toByteString <$> buildQuery conn q template xs
158 | otherwise = toByteString <$> buildQuery conn q template xs
158− where xs = renderParams qs
159+ where xs = toRow qs
160-- | Format a query string with a variable number of rows.
161-- | Format a query string with a variable number of rows.
@@ -170,105 +171,208 @@ formatQuery conn q@(Query template) qs
171-- Throws 'FormatError' if the query string could not be formatted
172-- Throws 'FormatError' if the query string could not be formatted
172-- correctly.
173-- correctly.
173−formatMany :: (QueryParams q) => Connection -> Query -> [q] -> IO ByteString
174+formatMany :: (ToRow q) => Connection -> Query -> [q] -> IO ByteString
174formatMany _ q [] = fmtError "no rows supplied" q []
175formatMany _ q [] = fmtError "no rows supplied" q []
175formatMany conn q@(Query template) qs = do
176formatMany conn q@(Query template) qs = do
176− case match re template [] of
177+ case parseTemplate template of
177− Just [_,before,qbits,after] -> do
178+ Just (before, qbits, after) -> do
178− bs <- mapM (buildQuery conn q qbits . renderParams) qs
179+ bs <- mapM (buildQuery conn q qbits . toRow) qs
179− return . toByteString . mconcat $ fromByteString before :
180+ return . toByteString . mconcat $ byteString before :
180− intersperse (fromChar ',') bs ++
181+ intersperse (char8 ',') bs ++
181− [fromByteString after]
182+ [byteString after]
182− _ -> error "foo"
183+ Nothing -> fmtError "syntax error in multi-row template" q []
185+-- Split the input string into three pieces, @before@, @qbits@, and @after@,
186+-- following this grammar:
188+-- start: ^ before qbits after $
189+-- before: ([^?]* [^?\w])? 'VALUES' \s*
190+-- qbits: '(' \s* '?' \s* (',' \s* '?' \s*)* ')'
194+-- \w: [A-Z] | [a-z] | [\x80-\xFF] | '_' | '$' | [0-9]
196+-- This would be much more concise with some sort of regex engine.
197+-- 'formatMany' used to use pcre-light instead of this hand-written parser,
198+-- but pcre is a hassle to install on Windows.
199+parseTemplate :: ByteString -> Maybe (ByteString, ByteString, ByteString)
200+parseTemplate template =
201+ -- Convert input string to uppercase, to facilitate searching.
202+ search $ B.map toUpper_ascii template
184− re = compile "^([^?]+\\bvalues\\s*)\
204+ -- Search for the next occurrence of "VALUES"
185− \(\\(\\s*[?](?:\\s*,\\s*[?])*\\s*\\))\
205+ search bs =
186− \([^?]*)$"
206+ case B.breakSubstring "VALUES" bs of
187− [caseless]
207+ (x, y)
208+ -- If "VALUES" is not present in the string, or any '?' characters
209+ -- were encountered prior to it, fail.
210+ | B.null y || ('?' `B.elem` x)
213+ -- If "VALUES" is preceded by an identifier character (a.k.a. \w),
214+ -- try the next occurrence.
215+ | not (B.null x) && isIdent (B.last x)
216+ -> search $ B.drop 6 y
218+ -- Otherwise, we have a legitimate "VALUES" token.
220+ -> parseQueryBits $ skipSpace $ B.drop 6 y
222+ -- Parse '(' \s* '?' \s* . If this doesn't match
223+ -- (and we don't consume a '?'), look for another "VALUES".
225+ -- qb points to the open paren (if present), meaning it points to the
226+ -- beginning of the "qbits" production described above. This is why we
227+ -- pass it down to finishQueryBits.
229+ | Just ('(', skipSpace -> bs1) <- B.uncons qb
230+ , Just ('?', skipSpace -> bs2) <- B.uncons bs1
231+ = finishQueryBits qb bs2
235+ -- Parse (',' \s* '?' \s*)* ')' [^?]* .
237+ -- Since we've already consumed at least one '?', there's no turning back.
238+ -- The parse has to succeed here, or the whole thing fails
239+ -- (because we don't allow '?' to appear outside of the VALUES list).
240+ finishQueryBits qb bs0
241+ | Just (')', bs1) <- B.uncons bs0
242+ = if '?' `B.elem` bs1
244+ else Just $ slice3 template qb bs1
245+ | Just (',', skipSpace -> bs1) <- B.uncons bs0
246+ , Just ('?', skipSpace -> bs2) <- B.uncons bs1
247+ = finishQueryBits qb bs2
251+ -- Slice a string into three pieces, given the start offset of the second
252+ -- and third pieces. Each "offset" is actually a tail of the uppercase
253+ -- version of the template string. Its length is used to infer the offset.
255+ -- It is important to note that we only slice the original template.
256+ -- We don't want our all-caps trick messing up the actual query string.
257+ slice3 source p1 p2 =
260+ (s1, source') = B.splitAt (B.length source - B.length p1) source
261+ (s2, source'') = B.splitAt (B.length p1 - B.length p2) source'
263+ toUpper_ascii c | c >= 'a' && c <= 'z' = toEnum (fromEnum c - 32)
266+ -- Based on the definition of {ident_cont} in src/backend/parser/scan.l
267+ -- in the PostgreSQL source. No need to check [a-z], since we converted
268+ -- the whole string to uppercase.
269+ isIdent c = (c >= '0' && c <= '9')
270+ || (c >= 'A' && c <= 'Z')
271+ || (c >= '\x80' && c <= '\xFF')
275+ -- Based on {space} in scan.l
276+ isSpace_ascii c = (c == ' ') || (c >= '\t' && c <= '\r')
278+ skipSpace = B.dropWhile isSpace_ascii
189−escapeStringConn conn s = withConnection conn $ \c -> do
190− PQ.escapeStringConn c s
192buildQuery :: Connection -> Query -> ByteString -> [Action] -> IO Builder
281buildQuery :: Connection -> Query -> ByteString -> [Action] -> IO Builder
193−buildQuery conn q template xs = zipParams (split template) <$> mapM sub xs
282+buildQuery conn q template xs =
194− where quote = inQuotes . fromByteString . maybe undefined id
283+ zipParams (split template) <$> mapM (buildAction conn q xs) xs
195− sub (Plain b) = pure b
284+ where split s =
196− sub (Escape s) = quote <$> escapeStringConn conn s
285+ -- This part escapes double '??'s to make literal '?'s possible
197− sub (Many ys) = mconcat <$> mapM sub ys
286+ -- in PostgreSQL queries using the JSON operators: @?@, @?|@ and @?&@
287+ let (h,t) = breakOnSingleQuestionMark s
198− split s = fromByteString h : if B.null t then [] else split (B.tail t)
291+ else split (B.tail t)
199− where (h,t) = B.break (=='?') s
200− zipParams (t:ts) (p:ps) = t `mappend` p `mappend` zipParams ts ps
292+ zipParams (t:ts) (p:ps) = t <> p <> zipParams ts ps
201 zipParams [t] [] = t
293 zipParams [t] [] = t
202− zipParams _ _ = fmtError (show (B.count '?' template) ++
294+ zipParams _ _ = fmtError (show countSingleQs ++
203− " '?' characters, but " ++
295+ " single '?' characters, but " ++
204 show (length xs) ++ " parameters") q xs
296 show (length xs) ++ " parameters") q xs
297+ countSingleQs = go 0 template
298+ where go i "" = (i :: Int)
299+ go i bs = case qms of
300+ ("?","?") -> go i nextQMBS
301+ ("?",_) -> go (i+1) nextQMBS
303+ where qms = B.splitAt 1 qmBS
304+ (qmBS,nextQMBS) = B.splitAt 2 qmBS'
305+ qmBS' = B.dropWhile (/= '?') bs
206-- | Execute an @INSERT@, @UPDATE@, or other SQL query that is not
307-- | Execute an @INSERT@, @UPDATE@, or other SQL query that is not
207-- expected to return results.
308-- expected to return results.
209-- Returns the number of rows affected.
310-- Returns the number of rows affected.
211−-- Throws 'FormatError' if the query could not be formatted correctly.
312+-- Throws 'FormatError' if the query could not be formatted correctly, or
313+-- a 'SqlError' exception if the backend returns an error.
212−execute :: (QueryParams q) => Connection -> Query -> q -> IO Int64
314+execute :: (ToRow q) => Connection -> Query -> q -> IO Int64
213execute conn template qs = do
315execute conn template qs = do
214 result <- exec conn =<< formatQuery conn template qs
316 result <- exec conn =<< formatQuery conn template qs
215 finishExecute conn template result
317 finishExecute conn template result
217−-- | A version of 'execute' that does not perform query substitution.
218−execute_ :: Connection -> Query -> IO Int64
219−execute_ conn q@(Query stmt) = do
220− result <- exec conn stmt
221− finishExecute conn q result
223-- | Execute a multi-row @INSERT@, @UPDATE@, or other SQL query that is not
319-- | Execute a multi-row @INSERT@, @UPDATE@, or other SQL query that is not
224-- expected to return results.
320-- expected to return results.
226−-- Returns the number of rows affected.
322+-- Returns the number of rows affected. If the list of parameters is empty,
323+-- this function will simply return 0 without issuing the query to the backend.
324+-- If this is not desired, consider using the 'Values' constructor instead.
228−-- Throws 'FormatError' if the query could not be formatted correctly.
326+-- Throws 'FormatError' if the query could not be formatted correctly, or
327+-- a 'SqlError' exception if the backend returns an error.
329+-- For example, here's a command that inserts two rows into a table
333+-- executeMany c [sql|
334+-- INSERT INTO sometable VALUES (?,?)
335+-- |] [(1, \"hello\"),(2, \"world\")]
338+-- Here's an canonical example of a multi-row update command:
341+-- executeMany c [sql|
344+-- FROM (VALUES (?,?)) as upd(x,y)
345+-- WHERE sometable.x = upd.x
346+-- |] [(1, \"hello\"),(2, \"world\")]
229−executeMany :: (QueryParams q) => Connection -> Query -> [q] -> IO Int64
349+executeMany :: (ToRow q) => Connection -> Query -> [q] -> IO Int64
230executeMany _ _ [] = return 0
350executeMany _ _ [] = return 0
231executeMany conn q qs = do
351executeMany conn q qs = do
232 result <- exec conn =<< formatMany conn q qs
352 result <- exec conn =<< formatMany conn q qs
233 finishExecute conn q result
353 finishExecute conn q result
355+-- | Execute @INSERT ... RETURNING@, @UPDATE ... RETURNING@, or other SQL
356+-- query that accepts multi-row input and is expected to return results.
357+-- Note that it is possible to write
358+-- @'query' conn "INSERT ... RETURNING ..." ...@
359+-- in cases where you are only inserting a single row, and do not need
360+-- functionality analogous to 'executeMany'.
362+-- If the list of parameters is empty, this function will simply return @[]@
363+-- without issuing the query to the backend. If this is not desired,
364+-- consider using the 'Values' constructor instead.
366+-- Throws 'FormatError' if the query could not be formatted correctly.
235−finishExecute :: Connection -> Query -> PQ.Result -> IO Int64
367+returning :: (ToRow q, FromRow r) => Connection -> Query -> [q] -> IO [r]
236−finishExecute conn q result = do
368+returning = returningWith fromRow
237− status <- PQ.resultStatus result
240− ncols <- PQ.nfields result
242− then throwIO $ QueryError ("execute resulted in " ++ show ncols ++
245− nstr <- PQ.cmdTuples result
246− return $ case nstr of
247− Nothing -> 0 -- is this appropriate?
248− Just str -> toInteger str
250− ncols <- PQ.nfields result
251− throwIO $ QueryError ("execute resulted in " ++ show ncols ++
253− PQ.CopyIn -> fail "FIXME: postgresql-simple does not currently support COPY IN"
254− PQ.CopyOut -> fail "FIXME: postgresql-simple does not currently support COPY OUT"
256− errormsg <- maybe "" id <$> PQ.resultErrorMessage result
257− statusmsg <- PQ.resStatus status
258− state <- maybe "" id <$> PQ.resultErrorField result PQ.DiagSqlstate
259− throwIO $ SqlError { sqlState = state
260− , sqlNativeError = fromEnum status
261− , sqlErrorMsg = B.concat [ "execute: ", statusmsg
264− toInteger str = B.foldl' delta 0 str
267− if '0' <= c && c <= '9'
268− then 10 * acc + fromIntegral (ord c - ord '0')
269− else error ("finishExecute: not an int: " ++ B.unpack str)
370+-- | A version of 'returning' taking parser as argument
371+returningWith :: (ToRow q) => RowParser r -> Connection -> Query -> [q] -> IO [r]
372+returningWith _ _ _ [] = return []
373+returningWith parser conn q qs = do
374+ result <- exec conn =<< formatMany conn q qs
375+ finishQueryWith parser conn q result
273-- | Perform a @SELECT@ or other SQL query that is expected to return
377-- | Perform a @SELECT@ or other SQL query that is expected to return
274-- results. All results are retrieved and converted before this
378-- results. All results are retrieved and converted before this
@@ -285,33 +389,44 @@ finishExecute conn q result = do
285-- using 'execute' instead of 'query').
389-- using 'execute' instead of 'query').
287-- * 'ResultError': result conversion failed.
391-- * 'ResultError': result conversion failed.
288−query :: (QueryParams q, QueryResults r)
392+--
393+-- * 'SqlError': the postgresql backend returned an error, e.g.
394+-- a syntax or type error, or an incorrect table or column name.
289− => Connection -> Query -> q -> IO [r]
395+query :: (ToRow q, FromRow r) => Connection -> Query -> q -> IO [r]
290−query conn template qs = do
396+query = queryWith fromRow
291− result <- exec conn =<< formatQuery conn template qs
292− finishQuery conn template result
294-- | A version of 'query' that does not perform query substitution.
398-- | A version of 'query' that does not perform query substitution.
295−query_ :: (QueryResults r) => Connection -> Query -> IO [r]
399+query_ :: (FromRow r) => Connection -> Query -> IO [r]
400+query_ = queryWith_ fromRow
402+-- | A version of 'query' taking parser as argument
403+queryWith :: ToRow q => RowParser r -> Connection -> Query -> q -> IO [r]
404+queryWith parser conn template qs = do
405+ result <- exec conn =<< formatQuery conn template qs
406+ finishQueryWith parser conn template result
408+-- | A version of 'query_' taking parser as argument
409+queryWith_ :: RowParser r -> Connection -> Query -> IO [r]
296−query_ conn q@(Query que) = do
410+queryWith_ parser conn q@(Query que) = do
297 result <- exec conn que
411 result <- exec conn que
298− finishQuery conn q result
412+ finishQueryWith parser conn q result
300-- | Perform a @SELECT@ or other SQL query that is expected to return
414-- | Perform a @SELECT@ or other SQL query that is expected to return
301-- results. Results are streamed incrementally from the server, and
415-- results. Results are streamed incrementally from the server, and
302-- consumed via a left fold.
416-- consumed via a left fold.
304−-- The result consumer must be carefully written to execute
305−-- quickly. If the consumer is slow, server resources will be tied up,
306−-- and other clients may not be able to update the tables from which
307−-- the results are being streamed.
309-- When dealing with small results, it may be simpler (and perhaps
418-- When dealing with small results, it may be simpler (and perhaps
310-- faster) to use 'query' instead.
419-- faster) to use 'query' instead.
312-- This fold is /not/ strict. The stream consumer is responsible for
421-- This fold is /not/ strict. The stream consumer is responsible for
313-- forcing the evaluation of its result to avoid space leaks.
422-- forcing the evaluation of its result to avoid space leaks.
424+-- This is implemented using a database cursor. As such, this requires
425+-- a transaction. This function will detect whether or not there is a
426+-- transaction in progress, and will create a 'ReadCommitted' 'ReadOnly'
427+-- transaction if needed. The cursor is given a unique temporary name,
428+-- so the consumer may itself call fold.
315-- Exceptions that may be thrown:
430-- Exceptions that may be thrown:
317-- * 'FormatError': the query string could not be formatted correctly.
432-- * 'FormatError': the query string could not be formatted correctly.
@@ -320,163 +435,202 @@ query_ conn q@(Query que) = do
320-- using 'execute' instead of 'query').
435-- using 'execute' instead of 'query').
322-- * 'ResultError': result conversion failed.
437-- * 'ResultError': result conversion failed.
323−fold :: (QueryParams q, QueryResults r) =>
438+--
439+-- * 'SqlError': the postgresql backend returned an error, e.g.
440+-- a syntax or type error, or an incorrect table or column name.
441+fold :: ( FromRow row, ToRow params )
446+ -> (a -> row -> IO a)
448+fold = foldWithOptions defaultFoldOptions
450+-- | A version of 'fold' taking a parser as an argument
451+foldWith :: ( ToRow params )
457+ -> (a -> row -> IO a)
459+foldWith = foldWithOptionsAndParser defaultFoldOptions
461+-- | Number of rows to fetch at a time. 'Automatic' currently defaults
462+-- to 256 rows, although it might be nice to make this more intelligent
463+-- based on e.g. the average size of the rows.
470+ fetchQuantity :: !FetchQuantity,
471+ transactionMode :: !TransactionMode
474+-- | defaults to 'Automatic', and 'TransactionMode' 'ReadCommitted' 'ReadOnly'
475+defaultFoldOptions :: FoldOptions
476+defaultFoldOptions = FoldOptions {
477+ fetchQuantity = Automatic,
478+ transactionMode = TransactionMode ReadCommitted ReadOnly
481+-- | The same as 'fold', but this provides a bit more control over
482+-- lower-level details. Currently, the number of rows fetched per
483+-- round-trip to the server and the transaction mode may be adjusted
484+-- accordingly. If the connection is already in a transaction,
485+-- then the existing transaction is used and thus the 'transactionMode'
486+-- option is ignored.
487+foldWithOptions :: ( FromRow row, ToRow params )
324− Connection
489+ -> Connection
325− -> Query -- ^ Query template.
490+ -> Query
326− -> q -- ^ Query parameters.
491+ -> params
327− -> a -- ^ Initial state for result consumer.
492+ -> a
328− -> (a -> r -> IO a) -- ^ Result consumer.
493+ -> (a -> row -> IO a)
495+foldWithOptions opts = foldWithOptionsAndParser opts fromRow
497+-- | A version of 'foldWithOptions' taking a parser as an argument
498+foldWithOptionsAndParser :: (ToRow params)
505+ -> (a -> row -> IO a)
330−fold conn template qs z f = do
507+foldWithOptionsAndParser opts parser conn template qs a f = do
331− Base.query conn =<< formatQuery conn template qs
508+ q <- formatQuery conn template qs
332− finishFold conn template z f
509+ doFold opts parser conn template (Query q) a f
335-- | A version of 'fold' that does not perform query substitution.
511-- | A version of 'fold' that does not perform query substitution.
336−fold_ :: (QueryResults r) =>
512+fold_ :: (FromRow r) =>
337 Connection
513 Connection
338 -> Query -- ^ Query.
514 -> Query -- ^ Query.
339 -> a -- ^ Initial state for result consumer.
515 -> a -- ^ Initial state for result consumer.
340 -> (a -> r -> IO a) -- ^ Result consumer.
516 -> (a -> r -> IO a) -- ^ Result consumer.
342−fold_ conn q@(Query que) z f = do
518+fold_ = foldWithOptions_ defaultFoldOptions
343− Base.query conn que
519+
344− finishFold conn q z f
520+-- | A version of 'fold_' taking a parser as an argument
345−--}
521+foldWith_ :: RowParser r
346−{--
522+ -> Connection
527+foldWith_ = foldWithOptionsAndParser_ defaultFoldOptions
529+foldWithOptions_ :: (FromRow r) =>
532+ -> Query -- ^ Query.
533+ -> a -- ^ Initial state for result consumer.
534+ -> (a -> r -> IO a) -- ^ Result consumer.
536+foldWithOptions_ opts conn query' a f = doFold opts fromRow conn query' query' a f
538+-- | A version of 'foldWithOptions_' taking a parser as an argument
539+foldWithOptionsAndParser_ :: FoldOptions
542+ -> Query -- ^ Query.
543+ -> a -- ^ Initial state for result consumer.
544+ -> (a -> r -> IO a) -- ^ Result consumer.
546+foldWithOptionsAndParser_ opts parser conn query' a f = doFold opts parser conn query' query' a f
548+doFold :: FoldOptions
554+ -> (a -> row -> IO a)
556+doFold FoldOptions{..} parser conn _template q a0 f = do
557+ stat <- withConnection conn PQ.transactionStatus
559+ PQ.TransIdle -> withTransactionMode transactionMode conn go
560+ PQ.TransInTrans -> go
561+ PQ.TransActive -> fail "foldWithOpts FIXME: PQ.TransActive"
562+ -- This _shouldn't_ occur in the current incarnation of
563+ -- the library, as we aren't using libpq asynchronously.
564+ -- However, it could occur in future incarnations of
565+ -- this library or if client code uses the Internal module
566+ -- to use raw libpq commands on postgresql-simple connections.
567+ PQ.TransInError -> fail "foldWithOpts FIXME: PQ.TransInError"
568+ -- This should be turned into a better error message.
569+ -- It is probably a bad idea to automatically roll
570+ -- back the transaction and start another.
571+ PQ.TransUnknown -> fail "foldWithOpts FIXME: PQ.TransUnknown"
572+ -- Not sure what this means.
575+ declareCursor conn q
577+ foldForwardWithParser cursor parser chunkSize f a
579+ go = bracket declare closeCursor $ \cursor ->
580+ let loop a = fetch cursor a >>=
586+-- FIXME: choose the Automatic chunkSize more intelligently
587+-- One possibility is to use the type of the results, although this
588+-- still isn't a perfect solution, given that common types (e.g. text)
589+-- are of highly variable size.
590+-- A refinement of this technique is to pick this number adaptively
591+-- as results are read in from the database.
592+ chunkSize = case fetchQuantity of
347-- | A version of 'fold' that does not transform a state value.
596-- | A version of 'fold' that does not transform a state value.
348−forEach :: (QueryParams q, QueryResults r) =>
597+forEach :: (ToRow q, FromRow r) =>
349 Connection
598 Connection
350 -> Query -- ^ Query template.
599 -> Query -- ^ Query template.
351 -> q -- ^ Query parameters.
600 -> q -- ^ Query parameters.
352 -> (r -> IO ()) -- ^ Result consumer.
601 -> (r -> IO ()) -- ^ Result consumer.
354−forEach conn template qs = fold conn template qs () . const
603+forEach = forEachWith fromRow
355{-# INLINE forEach #-}
604{-# INLINE forEach #-}
606+-- | A version of 'forEach' taking a parser as an argument
607+forEachWith :: ( ToRow q )
614+forEachWith parser conn template qs = foldWith parser conn template qs () . const
615+{-# INLINE forEachWith #-}
357-- | A version of 'forEach' that does not perform query substitution.
617-- | A version of 'forEach' that does not perform query substitution.
358−forEach_ :: (QueryResults r) =>
618+forEach_ :: (FromRow r) =>
359 Connection
619 Connection
360 -> Query -- ^ Query template.
620 -> Query -- ^ Query template.
361 -> (r -> IO ()) -- ^ Result consumer.
621 -> (r -> IO ()) -- ^ Result consumer.
363−forEach_ conn template = fold_ conn template () . const
623+forEach_ = forEachWith_ fromRow
364{-# INLINE forEach_ #-}
624{-# INLINE forEach_ #-}
367−forM' :: (Ord n, Num n) => n -> n -> (n -> IO a) -> IO [a]
626+forEachWith_ :: RowParser r
368−forM' lo hi m = loop hi []
371− | n < lo = return as
376−finishQuery :: (QueryResults r) => Connection -> Query -> PQ.Result -> IO [r]
377−finishQuery conn q result = do
378− status <- PQ.resultStatus result
381− throwIO $ QueryError "query resulted in a command response" q
383− ncols <- PQ.nfields result
384− fields <- forM' 0 (ncols-1) $ \column -> do
385− type_oid <- PQ.ftype result column
386− typename <- getTypename conn type_oid
388− nrows <- PQ.ntuples result
389− forM' 0 (nrows-1) $ \row -> do
390− values <- forM' 0 (ncols-1) (\col -> PQ.getvalue' result row col)
391− case convertResults fields values of
392− Left err -> throwIO err
394− PQ.CopyIn -> fail "FIXME: postgresql-simple does not currently support COPY IN"
395− PQ.CopyOut -> fail "FIXME: postgresql-simple does not currently support COPY OUT"
397− errormsg <- maybe "" id <$> PQ.resultErrorMessage result
398− statusmsg <- PQ.resStatus status
399− state <- maybe "" id <$> PQ.resultErrorField result PQ.DiagSqlstate
400− throwIO $ SqlError { sqlState = state
401− , sqlNativeError = fromEnum status
402− , sqlErrorMsg = B.concat [ "query: ", statusmsg
406−withResult (Base.storeResult conn) q $ \r fs -> do
408−/ flip fix [] $ \loop acc -> do
409− row <- Base.fetchRow r
411− [] -> return (reverse acc)
412− _ -> let !c = convertResults fs row
416−finishFold :: (QueryResults r) =>
417− Connection -> Query -> a -> (a -> r -> IO a) -> IO a
418−finishFold conn q z0 f = withResult (Base.useResult conn) q $ \r fs ->
419− flip fix z0 $ \loop z -> do
420− row <- Base.fetchRow r
423− _ -> (f z $! convertResults fs row) >>= loop
426−withResult :: (IO Result) -> Query -> (Result -> [Field] -> IO a) -> IO a
427−withResult fetchResult q act = bracket fetchResult Base.freeResult $ \r -> do
428− ncols <- Base.fieldCount (Right r)
430− then throwIO $ QueryError "query resulted in zero-column result" q
431− else act r =<< Base.fetchFields r
433−-- | Execute an action inside a SQL transaction.
435−-- This function initiates a transaction with a \"@begin
436−-- transaction@\" statement, then executes the supplied action. If
437−-- the action succeeds, the transaction will be completed with
438−-- 'Base.commit' before this function returns.
440−-- If the action throws /any/ kind of exception (not just a
441−-- PostgreSQL-related exception), the transaction will be rolled back using
442−-- 'rollback', then the exception will be rethrown.
443−withTransaction :: Connection -> IO a -> IO a
444−withTransaction conn act = do
446− r <- act `onException` rollback conn
450−-- | Rollback a transaction.
451−-- rollback :: (MonadCatchIO m,MonadIO m) => Connection -> m ()
452−rollback :: Connection -> IO ()
454− _ <- execute_ conn "ABORT"
457−-- | Commit a transaction.
458−-- commit :: (MonadCatchIO m,MonadIO m) => Connection -> m ()
627+ -> Connection
459−commit :: Connection -> IO ()
628+ -> Query
460−commit conn = do
629+ -> (r -> IO ())
461− _ <- execute_ conn "COMMIT"
630+ -> IO ()
462− return ()
631+forEachWith_ parser conn template = foldWith_ parser conn template () . const
463−
632+{-# INLINE forEachWith_ #-}
464−-- | Begin a transaction.
633+
465−-- begin :: (MonadCatchIO m,MonadIO m) => Connection -> m ()
466−begin :: Connection -> IO ()
468− _ <- execute_ conn "BEGIN"
471−fmtError :: String -> Query -> [Action] -> a
472−fmtError msg q xs = throw FormatError {
475− , fmtParams = map twiddle xs
477− where twiddle (Plain b) = toByteString b
478− twiddle (Escape s) = s
479− twiddle (Many ys) = B.concat (map twiddle ys)
@@ -504,9 +658,11 @@ fmtError msg q xs = throw FormatError {
505-- > import Database.PostgreSQL.Simple
659-- > import Database.PostgreSQL.Simple
507-- > hello = do
662-- > hello = do
508−-- > conn <- connect defaultConnectInfo
663+-- > conn <- connectPostgreSQL ""
509−-- > query conn "select 2 + 2"
664+-- > [Only i] <- query_ conn "select 2 + 2"
511-- A 'Query' value does not represent the actual query that will be
667-- A 'Query' value does not represent the actual query that will be
512-- executed, but is a template for constructing the final query.
668-- executed, but is a template for constructing the final query.
@@ -553,7 +709,7 @@ fmtError msg q xs = throw FormatError {
553-- Automated type inference means that you will often be able to avoid
709-- Automated type inference means that you will often be able to avoid
554-- supplying explicit type signatures for the elements of a tuple.
710-- supplying explicit type signatures for the elements of a tuple.
555-- However, sometimes the compiler will not be able to infer your
711-- However, sometimes the compiler will not be able to infer your
556−-- types. Consider a care where you write a numeric literal in a
712+-- types. Consider a case where you write a numeric literal in a
557-- parameter tuple:
713-- parameter tuple:
559-- > query conn "select ? + ?" (40,2)
715-- > query conn "select ? + ?" (40,2)
@@ -567,15 +723,30 @@ fmtError msg q xs = throw FormatError {
567-- The same kind of problem can arise with string literals if you have
723-- The same kind of problem can arise with string literals if you have
568-- the @OverloadedStrings@ language extension enabled. Again, just
724-- the @OverloadedStrings@ language extension enabled. Again, just
569-- use an explicit type signature if this happens.
725-- use an explicit type signature if this happens.
727+-- Finally, remember that the compiler must be able to infer the type
728+-- of a query's /results/ as well as its parameters. We might like
729+-- the following example to work:
731+-- > print =<< query_ conn "select 2 + 2"
733+-- Unfortunately, while a quick glance tells us that the result type
734+-- should be a single row containing a single numeric column, the
735+-- compiler has no way to infer what the types are. We can easily fix
736+-- this by providing an explicit type annotation:
738+-- > xs <- query_ conn "select 2 + 2"
739+-- > print (xs :: [Only Int])
571-- $only_param
741-- $only_param
573-- Haskell lacks a single-element tuple type, so if you have just one
743-- Haskell lacks a single-element tuple type, so if you have just one
574−-- value you want substituted into a query, what should you do?
744+-- value you want substituted into a query or a single-column result,
745+-- what should you do?
576-- The obvious approach would appear to be something like this:
747-- The obvious approach would appear to be something like this:
578−-- > instance (Param a) => QueryParam a where
749+-- > instance (ToField a) => ToRow a where
581-- Unfortunately, this wreaks havoc with type inference, so we take a
752-- Unfortunately, this wreaks havoc with type inference, so we take a
@@ -586,6 +757,9 @@ fmtError msg q xs = throw FormatError {
587-- > execute conn "insert into users (first_name) values (?)"
758-- > execute conn "insert into users (first_name) values (?)"
588-- > ["Nuala"]
759-- > ["Nuala"]
761+-- A row of /n/ query results is represented using an /n/-tuple, so
762+-- you should use 'Only' to represent a single-column result.
@@ -603,7 +777,7 @@ fmtError msg q xs = throw FormatError {
603-- Here's an example:
777-- Here's an example:
605-- > query conn "select * from users where first_name in ?" $
779-- > query conn "select * from users where first_name in ?" $
606−-- > In ["Anna", "Boris", "Carla"]
780+-- > Only $ In ["Anna", "Boris", "Carla"]
608-- If your 'In'-wrapped list is empty, the string @\"(null)\"@ will be
782-- If your 'In'-wrapped list is empty, the string @\"(null)\"@ will be
609-- substituted instead, to ensure that your clause remains
783-- substituted instead, to ensure that your clause remains
@@ -631,7 +805,7 @@ fmtError msg q xs = throw FormatError {
631-- * There must be no other \"@?@\" characters anywhere in your
805-- * There must be no other \"@?@\" characters anywhere in your
632-- template.
806-- template.
634−-- * There must one or more \"@?@\" in the parentheses.
808+-- * There must be one or more \"@?@\" in the parentheses.
636-- * Extra white space is fine.
810-- * Extra white space is fine.
@@ -652,10 +826,26 @@ fmtError msg q xs = throw FormatError {
652-- > insert into users (first_name,last_name) values
826-- > insert into users (first_name,last_name) values
653-- > ('Boris','Karloff'),('Ed','Wood')
827-- > ('Boris','Karloff'),('Ed','Wood')
831+-- PostgreSQL supports returning values from data manipulation statements
832+-- such as @INSERT@ and @UPDATE@. You can use these statements by
833+-- using 'query' instead of 'execute'. For multi-tuple inserts,
834+-- use 'returning' instead of 'executeMany'.
836+-- For example, were there an auto-incrementing @id@ column and
837+-- timestamp column @t@ that defaulted to the present time for the
838+-- @sales@ table, then the following query would insert two new
839+-- sales records and also return their new @id@s and timestamps.
841+-- > let q = "insert into sales (amount, label) values (?,?) returning id, t"
842+-- > xs :: [(Int, UTCTime)] <- query conn q (15,"Sawdust")
843+-- > ys :: [(Int, UTCTime)] <- returning conn q [(20,"Chips"),(300,"Wood")]
655-- $result
845-- $result
657-- The 'query' and 'query_' functions return a list of values in the
847-- The 'query' and 'query_' functions return a list of values in the
658−-- 'QueryResults' typeclass. This class performs automatic extraction
848+-- 'FromRow' typeclass. This class performs automatic extraction
659-- and type conversion of rows from a query result.
849-- and type conversion of rows from a query result.
661-- Here is a simple example of how to extract results:
851-- Here is a simple example of how to extract results:
@@ -686,7 +876,7 @@ fmtError msg q xs = throw FormatError {
687-- Although SQL can accommodate @NULL@ as a value for any of these
877-- Although SQL can accommodate @NULL@ as a value for any of these
688-- types, Haskell cannot. If your result contains columns that may be
878-- types, Haskell cannot. If your result contains columns that may be
689−-- @NULL@, be sure that you use 'Maybe' in those positions of of your
879+-- @NULL@, be sure that you use 'Maybe' in those positions of your
692-- > (Text, Maybe Int, Int)
882-- > (Text, Maybe Int, Int)
@@ -712,7 +902,7 @@ fmtError msg q xs = throw FormatError {
712-- all values of the given PostgreSQL type is considered \"compatible\".
902-- all values of the given PostgreSQL type is considered \"compatible\".
713-- For instance, you can always extract a PostgreSQL 16-bit @SMALLINT@
903-- For instance, you can always extract a PostgreSQL 16-bit @SMALLINT@
714-- column to a Haskell 'Int'. The Haskell 'Float' type can accurately
904-- column to a Haskell 'Int'. The Haskell 'Float' type can accurately
715−-- represent a @SMALLINT@, so it is considered compatble with those types.
905+-- represent a @SMALLINT@, so it is considered compatible with those types.
717-- * A numeric compatibility check is based only on the type of a
907-- * A numeric compatibility check is based only on the type of a
718-- column, /not/ on its values. For instance, a PostgreSQL 64-bit
908-- column, /not/ on its values. For instance, a PostgreSQL 64-bit
@@ -726,25 +916,3 @@ fmtError msg q xs = throw FormatError {
726-- UTF-8. If you use some other encoding, decoding may fail or give
916-- UTF-8. If you use some other encoding, decoding may fail or give
727-- wrong results. In such cases, write a @newtype@ wrapper and a
917-- wrong results. In such cases, write a @newtype@ wrapper and a
728-- custom 'Result' instance to handle your encoding.
918-- custom 'Result' instance to handle your encoding.
730−getTypename :: Connection -> PQ.Oid -> IO ByteString
731−getTypename conn@Connection{..} oid =
732− case oid2builtin oid of
733− Just builtin -> return $! builtin2typname builtin
734− Nothing -> modifyMVar connectionObjects $ \oidmap -> do
735− case IntMap.lookup (oid2int oid) oidmap of
736− Just name -> return (oidmap, name)
738− names <- query conn "SELECT typname FROM pg_type WHERE oid=?"
740− name <- case names of
741− [] -> return $ throw SqlError {
742− sqlNativeError = -1,
743− sqlErrorMsg = "invalid type oid",
746− [Only x] -> return x
747− _ -> fail "typename query returned more than one result"
748− -- oid is a primary key, so the query should
749− -- never return more than one result
750− return (IntMap.insert (oid2int oid) name oidmap, name)