@@ -1,14 +1,18 @@
1−{-# LANGUAGE DeriveDataTypeable, RecordWildCards, NamedFieldPuns #-}
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE NamedFieldPuns #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PatternGuards #-}
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,26 +55,35 @@ 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
84+ -- ** Queries taking parser as argument
71 -- * Queries that stream results
87 -- * Queries that stream results
72 , FoldOptions(..)
88 , FoldOptions(..)
73 , FetchQuantity(..)
89 , FetchQuantity(..)
@@ -78,6 +94,15 @@ module Database.PostgreSQL.Simple
78 , foldWithOptions_
94 , foldWithOptions_
80 , forEach_
96 , forEach_
98+ -- ** Queries that stream results taking a parser as an argument
100+ , foldWithOptionsAndParser
102+ , foldWithOptionsAndParser_
81 -- * Statements that do not return results
106 -- * Statements that do not return results
82 , execute
107 , execute
83 , execute_
108 , execute_
@@ -85,18 +110,9 @@ module Database.PostgreSQL.Simple
85-- , Base.insertID
110-- , Base.insertID
86 -- * Transaction handling
111 -- * Transaction handling
87 , withTransaction
112 , withTransaction
88− , TransactionMode(..)
113+ , withSavepoint
91− , defaultTransactionMode
92− , defaultIsolationLevel
93− , defaultReadWriteMode
94− , withTransactionLevel
95− , withTransactionMode
96-- , Base.autocommit
114-- , Base.autocommit
101 , rollback
117 , rollback
102 -- * Helper functions
118 -- * Helper functions
@@ -104,59 +120,27 @@ module Database.PostgreSQL.Simple
104 , formatQuery
120 , formatQuery
107−import Blaze.ByteString.Builder
123+import Data.ByteString.Builder (Builder, byteString, char8)
108− ( Builder, fromByteString, toByteString )
109−import Blaze.ByteString.Builder.Char8 (fromChar)
110−import Control.Applicative ((<$>), pure)
124+import Control.Applicative ((<$>))
111−import Control.Concurrent.MVar
125+import Control.Exception as E
112−import Control.Exception
113− ( Exception, bracket, onException, throw, throwIO, finally )
114−import Control.Monad (foldM)
115−import Control.Monad.Fix (fix)
116import Data.ByteString (ByteString)
126import Data.ByteString (ByteString)
117−import Data.Char(ord)
118import Data.Int (Int64)
127import Data.Int (Int64)
119−import qualified Data.IntMap as IntMap
120import Data.List (intersperse)
128import Data.List (intersperse)
121−import Data.Monoid (mappend, mconcat)
129+import Data.Monoid (mconcat)
122−import Data.Typeable (Typeable)
130+import Database.PostgreSQL.Simple.Compat ((<>), toByteString)
123−import Database.PostgreSQL.Simple.BuiltinTypes
131+import Database.PostgreSQL.Simple.Cursor
124− ( oid2builtin, builtin2typname )
125import Database.PostgreSQL.Simple.FromField (ResultError(..))
132import Database.PostgreSQL.Simple.FromField (ResultError(..))
126import Database.PostgreSQL.Simple.FromRow (FromRow(..))
133import Database.PostgreSQL.Simple.FromRow (FromRow(..))
127−import Database.PostgreSQL.Simple.Ok
134+import Database.PostgreSQL.Simple.ToField (Action(..))
128−import Database.PostgreSQL.Simple.Param (Action(..), inQuotes)
129−import Database.PostgreSQL.Simple.QueryParams (QueryParams(..))
135+import Database.PostgreSQL.Simple.ToRow (ToRow(..))
130import Database.PostgreSQL.Simple.Types
136import Database.PostgreSQL.Simple.Types
131− ( Binary(..), In(..), Only(..), Query(..) )
137+ ( Binary(..), In(..), Only(..), Query(..), (:.)(..) )
132import Database.PostgreSQL.Simple.Internal as Base
138import Database.PostgreSQL.Simple.Internal as Base
139+import Database.PostgreSQL.Simple.Internal.PQResultUtils
140+import Database.PostgreSQL.Simple.Transaction
133import qualified Database.PostgreSQL.LibPQ as PQ
141import qualified Database.PostgreSQL.LibPQ as PQ
134−import Text.Regex.PCRE.Light (compile, caseless, match)
135import qualified Data.ByteString.Char8 as B
142import qualified Data.ByteString.Char8 as B
136−import qualified Data.Vector as V
143+
137−import Control.Exception
138−import Control.Monad.Trans.Reader
139−import Control.Monad.Trans.State.Strict
141−-- | Exception thrown if a 'Query' could not be formatted correctly.
142−-- This may occur if the number of \'@?@\' characters in the query
143−-- string does not match the number of parameters provided.
144−data FormatError = FormatError {
145− fmtMessage :: String
147− , fmtParams :: [ByteString]
148− } deriving (Eq, Show, Typeable)
150−instance Exception FormatError
152−-- | Exception thrown if 'query' is used to perform an @INSERT@-like
153−-- operation, or 'execute' is used to perform a @SELECT@-like operation.
154−data QueryError = QueryError {
157− } deriving (Eq, Show, Typeable)
159−instance Exception QueryError
161-- | Format a query string.
145-- | Format a query string.
@@ -168,11 +152,11 @@ instance Exception QueryError
169-- Throws 'FormatError' if the query string could not be formatted
153-- Throws 'FormatError' if the query string could not be formatted
170-- correctly.
154-- correctly.
171−formatQuery :: QueryParams q => Connection -> Query -> q -> IO ByteString
155+formatQuery :: ToRow q => Connection -> Query -> q -> IO ByteString
172formatQuery conn q@(Query template) qs
156formatQuery conn q@(Query template) qs
173 | null xs && '?' `B.notElem` template = return template
157 | null xs && '?' `B.notElem` template = return template
174 | otherwise = toByteString <$> buildQuery conn q template xs
158 | otherwise = toByteString <$> buildQuery conn q template xs
175− where xs = renderParams qs
159+ where xs = toRow qs
177-- | Format a query string with a variable number of rows.
161-- | Format a query string with a variable number of rows.
@@ -187,105 +171,208 @@ formatQuery conn q@(Query template) qs
188-- Throws 'FormatError' if the query string could not be formatted
172-- Throws 'FormatError' if the query string could not be formatted
189-- correctly.
173-- correctly.
190−formatMany :: (QueryParams q) => Connection -> Query -> [q] -> IO ByteString
174+formatMany :: (ToRow q) => Connection -> Query -> [q] -> IO ByteString
191formatMany _ q [] = fmtError "no rows supplied" q []
175formatMany _ q [] = fmtError "no rows supplied" q []
192formatMany conn q@(Query template) qs = do
176formatMany conn q@(Query template) qs = do
193− case match re template [] of
177+ case parseTemplate template of
194− Just [_,before,qbits,after] -> do
178+ Just (before, qbits, after) -> do
195− bs <- mapM (buildQuery conn q qbits . renderParams) qs
179+ bs <- mapM (buildQuery conn q qbits . toRow) qs
196− return . toByteString . mconcat $ fromByteString before :
180+ return . toByteString . mconcat $ byteString before :
197− intersperse (fromChar ',') bs ++
181+ intersperse (char8 ',') bs ++
198− [fromByteString after]
182+ [byteString after]
199− _ -> 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
201− re = compile "^([^?]+\\bvalues\\s*)\
204+ -- Search for the next occurrence of "VALUES"
202− \(\\(\\s*[?](?:\\s*,\\s*[?])*\\s*\\))\
205+ search bs =
203− \([^?]*)$"
206+ case B.breakSubstring "VALUES" bs of
204− [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
206−escapeStringConn conn s = withConnection conn $ \c -> do
207− PQ.escapeStringConn c s
209buildQuery :: Connection -> Query -> ByteString -> [Action] -> IO Builder
281buildQuery :: Connection -> Query -> ByteString -> [Action] -> IO Builder
210−buildQuery conn q template xs = zipParams (split template) <$> mapM sub xs
282+buildQuery conn q template xs =
211− where quote = inQuotes . fromByteString . maybe undefined id
283+ zipParams (split template) <$> mapM (buildAction conn q xs) xs
212− sub (Plain b) = pure b
284+ where split s =
213− sub (Escape s) = quote <$> escapeStringConn conn s
285+ -- This part escapes double '??'s to make literal '?'s possible
214− sub (Many ys) = mconcat <$> mapM sub ys
286+ -- in PostgreSQL queries using the JSON operators: @?@, @?|@ and @?&@
287+ let (h,t) = breakOnSingleQuestionMark s
215− split s = fromByteString h : if B.null t then [] else split (B.tail t)
291+ else split (B.tail t)
216− where (h,t) = B.break (=='?') s
217− zipParams (t:ts) (p:ps) = t `mappend` p `mappend` zipParams ts ps
292+ zipParams (t:ts) (p:ps) = t <> p <> zipParams ts ps
218 zipParams [t] [] = t
293 zipParams [t] [] = t
219− zipParams _ _ = fmtError (show (B.count '?' template) ++
294+ zipParams _ _ = fmtError (show countSingleQs ++
220− " '?' characters, but " ++
295+ " single '?' characters, but " ++
221 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
223-- | Execute an @INSERT@, @UPDATE@, or other SQL query that is not
307-- | Execute an @INSERT@, @UPDATE@, or other SQL query that is not
224-- expected to return results.
308-- expected to return results.
226-- Returns the number of rows affected.
310-- Returns the number of rows affected.
228−-- 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.
229−execute :: (QueryParams q) => Connection -> Query -> q -> IO Int64
314+execute :: (ToRow q) => Connection -> Query -> q -> IO Int64
230execute conn template qs = do
315execute conn template qs = do
231 result <- exec conn =<< formatQuery conn template qs
316 result <- exec conn =<< formatQuery conn template qs
232 finishExecute conn template result
317 finishExecute conn template result
234−-- | A version of 'execute' that does not perform query substitution.
235−execute_ :: Connection -> Query -> IO Int64
236−execute_ conn q@(Query stmt) = do
237− result <- exec conn stmt
238− finishExecute conn q result
240-- | 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
241-- expected to return results.
320-- expected to return results.
243−-- 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.
245−-- 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\")]
246−executeMany :: (QueryParams q) => Connection -> Query -> [q] -> IO Int64
349+executeMany :: (ToRow q) => Connection -> Query -> [q] -> IO Int64
247executeMany _ _ [] = return 0
350executeMany _ _ [] = return 0
248executeMany conn q qs = do
351executeMany conn q qs = do
249 result <- exec conn =<< formatMany conn q qs
352 result <- exec conn =<< formatMany conn q qs
250 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.
252−finishExecute :: Connection -> Query -> PQ.Result -> IO Int64
367+returning :: (ToRow q, FromRow r) => Connection -> Query -> [q] -> IO [r]
253−finishExecute conn q result = do
368+returning = returningWith fromRow
254− status <- PQ.resultStatus result
257− ncols <- PQ.nfields result
259− then throwIO $ QueryError ("execute resulted in " ++ show ncols ++
262− nstr <- PQ.cmdTuples result
263− return $ case nstr of
264− Nothing -> 0 -- is this appropriate?
265− Just str -> toInteger str
267− ncols <- PQ.nfields result
268− throwIO $ QueryError ("execute resulted in " ++ show ncols ++
270− PQ.CopyIn -> fail "FIXME: postgresql-simple does not currently support COPY IN"
271− PQ.CopyOut -> fail "FIXME: postgresql-simple does not currently support COPY OUT"
273− errormsg <- maybe "" id <$> PQ.resultErrorMessage result
274− statusmsg <- PQ.resStatus status
275− state <- maybe "" id <$> PQ.resultErrorField result PQ.DiagSqlstate
276− throwIO $ SqlError { sqlState = state
277− , sqlNativeError = fromEnum status
278− , sqlErrorMsg = B.concat [ "execute: ", statusmsg
281− toInteger str = B.foldl' delta 0 str
284− if '0' <= c && c <= '9'
285− then 10 * acc + fromIntegral (ord c - ord '0')
286− 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
290-- | 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
291-- results. All results are retrieved and converted before this
378-- results. All results are retrieved and converted before this
@@ -302,17 +389,27 @@ finishExecute conn q result = do
302-- using 'execute' instead of 'query').
389-- using 'execute' instead of 'query').
304-- * 'ResultError': result conversion failed.
391-- * 'ResultError': result conversion failed.
305−query :: (QueryParams q, FromRow 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.
306− => Connection -> Query -> q -> IO [r]
395+query :: (ToRow q, FromRow r) => Connection -> Query -> q -> IO [r]
307−query conn template qs = do
396+query = queryWith fromRow
308− result <- exec conn =<< formatQuery conn template qs
309− finishQuery conn template result
311-- | A version of 'query' that does not perform query substitution.
398-- | A version of 'query' that does not perform query substitution.
312query_ :: (FromRow r) => Connection -> Query -> IO [r]
399query_ :: (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]
313−query_ conn q@(Query que) = do
410+queryWith_ parser conn q@(Query que) = do
314 result <- exec conn que
411 result <- exec conn que
315− finishQuery conn q result
412+ finishQueryWith parser conn q result
317-- | 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
318-- results. Results are streamed incrementally from the server, and
415-- results. Results are streamed incrementally from the server, and
@@ -324,6 +421,12 @@ query_ conn q@(Query que) = do
324-- This fold is /not/ strict. The stream consumer is responsible for
421-- This fold is /not/ strict. The stream consumer is responsible for
325-- 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.
327-- Exceptions that may be thrown:
430-- Exceptions that may be thrown:
329-- * 'FormatError': the query string could not be formatted correctly.
432-- * 'FormatError': the query string could not be formatted correctly.
@@ -332,8 +435,10 @@ query_ conn q@(Query que) = do
332-- using 'execute' instead of 'query').
435-- using 'execute' instead of 'query').
334-- * 'ResultError': result conversion failed.
437-- * 'ResultError': result conversion failed.
439+-- * 'SqlError': the postgresql backend returned an error, e.g.
440+-- a syntax or type error, or an incorrect table or column name.
336−fold :: ( FromRow row, QueryParams params )
441+fold :: ( FromRow row, ToRow params )
337 => Connection
442 => Connection
339 -> params
444 -> params
@@ -342,6 +447,20 @@ fold :: ( FromRow row, QueryParams params )
343fold = foldWithOptions defaultFoldOptions
448fold = 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.
345data FetchQuantity
464data FetchQuantity
346 = Automatic
465 = Automatic
347 | Fixed !Int
466 | Fixed !Int
@@ -352,12 +471,20 @@ data FoldOptions
352 transactionMode :: !TransactionMode
471 transactionMode :: !TransactionMode
474+-- | defaults to 'Automatic', and 'TransactionMode' 'ReadCommitted' 'ReadOnly'
475+defaultFoldOptions :: FoldOptions
355defaultFoldOptions = FoldOptions {
476defaultFoldOptions = FoldOptions {
356 fetchQuantity = Automatic,
477 fetchQuantity = Automatic,
357 transactionMode = TransactionMode ReadCommitted ReadOnly
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.
360−foldWithOptions :: ( FromRow row, QueryParams params )
487+foldWithOptions :: ( FromRow row, ToRow params )
361 => FoldOptions
488 => FoldOptions
362 -> Connection
489 -> Connection
@@ -365,9 +492,21 @@ foldWithOptions :: ( FromRow row, QueryParams params )
366 -> (a -> row -> IO a)
493 -> (a -> row -> IO a)
368−foldWithOptions opts conn template qs a f = do
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)
507+foldWithOptionsAndParser opts parser conn template qs a f = do
369 q <- formatQuery conn template qs
508 q <- formatQuery conn template qs
370− doFold opts conn template (Query q) a f
509+ doFold opts parser conn template (Query q) a f
372-- | A version of 'fold' that does not perform query substitution.
511-- | A version of 'fold' that does not perform query substitution.
373fold_ :: (FromRow r) =>
512fold_ :: (FromRow r) =>
@@ -378,6 +517,14 @@ fold_ :: (FromRow r) =>
379fold_ = foldWithOptions_ defaultFoldOptions
518fold_ = foldWithOptions_ defaultFoldOptions
520+-- | A version of 'fold_' taking a parser as an argument
521+foldWith_ :: RowParser r
527+foldWith_ = foldWithOptionsAndParser_ defaultFoldOptions
382foldWithOptions_ :: (FromRow r) =>
529foldWithOptions_ :: (FromRow r) =>
383 FoldOptions
530 FoldOptions
@@ -386,18 +533,27 @@ foldWithOptions_ :: (FromRow r) =>
386 -> a -- ^ Initial state for result consumer.
533 -> a -- ^ Initial state for result consumer.
387 -> (a -> r -> IO a) -- ^ Result consumer.
534 -> (a -> r -> IO a) -- ^ Result consumer.
389−foldWithOptions_ opts conn query a f = doFold opts conn query query a f
536+foldWithOptions_ opts conn query' a f = doFold opts fromRow conn query' query' a f
391−
538+-- | A version of 'foldWithOptions_' taking a parser as an argument
392−doFold :: ( FromRow row )
539+foldWithOptionsAndParser_ :: FoldOptions
393− => FoldOptions
540+ -> RowParser r
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
394 -> Connection
550 -> Connection
398 -> (a -> row -> IO a)
554 -> (a -> row -> IO a)
400−doFold FoldOptions{..} conn _template q a f = do
556+doFold FoldOptions{..} parser conn _template q a0 f = do
401 stat <- withConnection conn PQ.transactionStatus
557 stat <- withConnection conn PQ.transactionStatus
402 case stat of
558 case stat of
403 PQ.TransIdle -> withTransactionMode transactionMode conn go
559 PQ.TransIdle -> withTransactionMode transactionMode conn go
@@ -415,11 +571,17 @@ doFold FoldOptions{..} conn _template q a f = do
415 PQ.TransUnknown -> fail "foldWithOpts FIXME: PQ.TransUnknown"
571 PQ.TransUnknown -> fail "foldWithOpts FIXME: PQ.TransUnknown"
416 -- Not sure what this means.
572 -- Not sure what this means.
418− go = do
574+ declare =
419− -- FIXME: what about name clashes with already-declared cursors?
575+ declareCursor conn q
420− _ <- execute_ conn ("DECLARE fold NO SCROLL CURSOR FOR "
576+ fetch cursor a =
421− `mappend` q)
577+ foldForwardWithParser cursor parser chunkSize f a
422− loop a `finally` execute_ conn "CLOSE fold"
578+
579+ go = bracket declare closeCursor $ \cursor ->
580+ let loop a = fetch cursor a >>=
424-- FIXME: choose the Automatic chunkSize more intelligently
586-- FIXME: choose the Automatic chunkSize more intelligently
425-- One possibility is to use the type of the results, although this
587-- One possibility is to use the type of the results, although this
@@ -430,193 +592,45 @@ doFold FoldOptions{..} conn _template q a f = do
430 chunkSize = case fetchQuantity of
592 chunkSize = case fetchQuantity of
431 Automatic -> 256
593 Automatic -> 256
432 Fixed n -> n
594 Fixed n -> n
434− rs <- query conn "FETCH FORWARD ? FROM fold" (Only chunkSize)
435− if null rs then return a else foldM f a rs >>= loop
437-- | A version of 'fold' that does not transform a state value.
596-- | A version of 'fold' that does not transform a state value.
438−forEach :: (QueryParams q, FromRow r) =>
597+forEach :: (ToRow q, FromRow r) =>
439 Connection
598 Connection
440 -> Query -- ^ Query template.
599 -> Query -- ^ Query template.
441 -> q -- ^ Query parameters.
600 -> q -- ^ Query parameters.
442 -> (r -> IO ()) -- ^ Result consumer.
601 -> (r -> IO ()) -- ^ Result consumer.
444−forEach conn template qs = fold conn template qs () . const
603+forEach = forEachWith fromRow
445{-# 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 #-}
447-- | A version of 'forEach' that does not perform query substitution.
617-- | A version of 'forEach' that does not perform query substitution.
448forEach_ :: (FromRow r) =>
618forEach_ :: (FromRow r) =>
449 Connection
619 Connection
450 -> Query -- ^ Query template.
620 -> Query -- ^ Query template.
451 -> (r -> IO ()) -- ^ Result consumer.
621 -> (r -> IO ()) -- ^ Result consumer.
453−forEach_ conn template = fold_ conn template () . const
623+forEach_ = forEachWith_ fromRow
454{-# INLINE forEach_ #-}
624{-# INLINE forEach_ #-}
456−forM' :: (Ord n, Num n) => n -> n -> (n -> IO a) -> IO [a]
626+forEachWith_ :: RowParser r
457−forM' lo hi m = loop hi []
627+ -> Connection
459− loop !n !as
629+ -> (r -> IO ())
460− | n < lo = return as
630+ -> IO ()
461− | otherwise = do
631+forEachWith_ parser conn template = foldWith_ parser conn template () . const
462− a <- m n
632+{-# INLINE forEachWith_ #-}
463− loop (n-1) (a:as)
633+
465−finishQuery :: (FromRow r) => Connection -> Query -> PQ.Result -> IO [r]
466−finishQuery conn q result = do
467− status <- PQ.resultStatus result
470− throwIO $ QueryError "query resulted in a command response" q
472− ncols <- PQ.nfields result
473− let unCol (PQ.Col x) = fromIntegral x
474− typenames <- V.generateM (unCol ncols)
475− (\(PQ.Col . fromIntegral -> col) -> do
476− getTypename conn =<< PQ.ftype result col)
477− nrows <- PQ.ntuples result
478− ncols <- PQ.nfields result
479− forM' 0 (nrows-1) $ \row -> do
480− let rw = Row row typenames result
481− case runStateT (runReaderT (unRP fromRow) rw) 0 of
482− Ok (val,col) | col == ncols -> return val
484− vals <- forM' 0 (ncols-1) $ \c -> do
485− v <- PQ.getvalue result row c
486− return ( typenames V.! unCol c
488− throw (ConversionFailed
489− (show (unCol ncols) ++ " values: " ++ show vals)
490− (show (unCol col) ++ " slots in target type")
491− "mismatch between number of columns to \
492− \convert and number in target type")
493− Errors [] -> throwIO $ ConversionFailed "" "" "unknown error"
494− Errors [x] -> throwIO x
495− Errors xs -> throwIO $ ManyErrors xs
497−ellipsis :: ByteString -> ByteString
499− | B.length bs > 15 = B.take 10 bs `B.append` "[...]"
502−-- | Throw a 'ConversionFailed' exception, indicating a mismatch
503−-- between the number of columns in the 'Field' and row, and the
504−-- number in the collection to be converted to.
505−convertError :: [Field]
506− -- ^ Descriptors of fields to be converted.
507− -> [Maybe ByteString]
508− -- ^ Contents of the row to be converted.
510− -- ^ Number of columns expected for conversion. For
511− -- instance, if converting to a 3-tuple, the number to
512− -- provide here would be 3.
513− -> Either SomeException a
514−convertError fs vs n = Left . SomeException $ ConversionFailed
515− (show (length fs) ++ " values: " ++ show (zip (map typename fs)
516− (map (fmap ellipsis) vs)))
517− (show n ++ " slots in target type")
518− "mismatch between number of columns to convert and number in target type"
521−-- | Of the four isolation levels defined by the SQL standard,
522−-- these are the three levels distinguished by PostgreSQL as of version 9.0.
523−-- See <http://www.postgresql.org/docs/9.1/static/transaction-iso.html>
524−-- for more information.
530− deriving (Show, Eq, Ord, Enum, Bounded)
535− deriving (Show, Eq, Ord, Enum, Bounded)
537−data TransactionMode = TransactionMode {
538− isolationLevel :: !IsolationLevel,
539− readWriteMode :: !ReadWriteMode
540− } deriving (Show, Eq)
542−defaultTransactionMode :: TransactionMode
543−defaultTransactionMode = TransactionMode ReadCommitted ReadWrite
545−defaultIsolationLevel :: IsolationLevel
546−defaultIsolationLevel = ReadCommitted
548−defaultReadWriteMode :: ReadWriteMode
549−defaultReadWriteMode = ReadWrite
551−-- | Execute an action inside a SQL transaction.
553−-- This function initiates a transaction with a \"@begin
554−-- transaction@\" statement, then executes the supplied action. If
555−-- the action succeeds, the transaction will be completed with
556−-- 'Base.commit' before this function returns.
558−-- If the action throws /any/ kind of exception (not just a
559−-- PostgreSQL-related exception), the transaction will be rolled back using
560−-- 'rollback', then the exception will be rethrown.
561−withTransaction :: Connection -> IO a -> IO a
562−withTransaction = withTransactionMode defaultTransactionMode
564−-- | Execute an action inside a SQL transaction with a given isolation level.
565−withTransactionLevel :: IsolationLevel -> Connection -> IO a -> IO a
566−withTransactionLevel lvl
567− = withTransactionMode defaultTransactionMode { isolationLevel = lvl }
569−-- | Execute an action inside a SQL transaction with a given transaction mode.
570−withTransactionMode :: TransactionMode -> Connection -> IO a -> IO a
571−withTransactionMode mode conn act = do
573− r <- act `onException` rollback conn
577−-- | Rollback a transaction.
578−rollback :: Connection -> IO ()
579−rollback conn = execute_ conn "ABORT" >> return ()
581−-- | Commit a transaction.
582−commit :: Connection -> IO ()
583−commit conn = execute_ conn "COMMIT" >> return ()
585−-- | Begin a transaction.
586−begin :: Connection -> IO ()
587−begin = beginMode defaultTransactionMode
589−-- | Begin a transaction with a given isolation level
590−beginLevel :: IsolationLevel -> Connection -> IO ()
591−beginLevel lvl = beginMode defaultTransactionMode { isolationLevel = lvl }
593−-- | Begin a transaction with a given transaction mode
594−beginMode :: TransactionMode -> Connection -> IO ()
595−beginMode mode conn = do
596− execute_ conn $! case mode of
597− TransactionMode ReadCommitted ReadWrite ->
599− TransactionMode ReadCommitted ReadOnly ->
601− TransactionMode RepeatableRead ReadWrite ->
602− "BEGIN ISOLATION LEVEL REPEATABLE READ"
603− TransactionMode RepeatableRead ReadOnly ->
604− "BEGIN ISOLATION LEVEL REPEATABLE READ READ ONLY"
605− TransactionMode Serializable ReadWrite ->
606− "BEGIN ISOLATION LEVEL SERIALIZABLE"
607− TransactionMode Serializable ReadOnly ->
608− "BEGIN ISOLATION LEVEL SERIALIZABLE READ ONLY"
611−fmtError :: String -> Query -> [Action] -> a
612−fmtError msg q xs = throw FormatError {
615− , fmtParams = map twiddle xs
617− where twiddle (Plain b) = toByteString b
618− twiddle (Escape s) = s
619− twiddle (Many ys) = B.concat (map twiddle ys)
@@ -644,9 +658,11 @@ fmtError msg q xs = throw FormatError {
645-- > import Database.PostgreSQL.Simple
659-- > import Database.PostgreSQL.Simple
647-- > hello = do
662-- > hello = do
648−-- > conn <- connect defaultConnectInfo
663+-- > conn <- connectPostgreSQL ""
649−-- > query conn "select 2 + 2"
664+-- > [Only i] <- query_ conn "select 2 + 2"
651-- 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
652-- executed, but is a template for constructing the final query.
668-- executed, but is a template for constructing the final query.
@@ -693,7 +709,7 @@ fmtError msg q xs = throw FormatError {
693-- 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
694-- supplying explicit type signatures for the elements of a tuple.
710-- supplying explicit type signatures for the elements of a tuple.
695-- However, sometimes the compiler will not be able to infer your
711-- However, sometimes the compiler will not be able to infer your
696−-- 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
697-- parameter tuple:
713-- parameter tuple:
699-- > query conn "select ? + ?" (40,2)
715-- > query conn "select ? + ?" (40,2)
@@ -707,15 +723,30 @@ fmtError msg q xs = throw FormatError {
707-- 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
708-- the @OverloadedStrings@ language extension enabled. Again, just
724-- the @OverloadedStrings@ language extension enabled. Again, just
709-- 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])
711-- $only_param
741-- $only_param
713-- 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
714−-- 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?
716-- The obvious approach would appear to be something like this:
747-- The obvious approach would appear to be something like this:
718−-- > instance (Param a) => QueryParam a where
749+-- > instance (ToField a) => ToRow a where
721-- Unfortunately, this wreaks havoc with type inference, so we take a
752-- Unfortunately, this wreaks havoc with type inference, so we take a
@@ -726,6 +757,9 @@ fmtError msg q xs = throw FormatError {
727-- > execute conn "insert into users (first_name) values (?)"
758-- > execute conn "insert into users (first_name) values (?)"
728-- > ["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.
@@ -743,7 +777,7 @@ fmtError msg q xs = throw FormatError {
743-- Here's an example:
777-- Here's an example:
745-- > query conn "select * from users where first_name in ?" $
779-- > query conn "select * from users where first_name in ?" $
746−-- > In ["Anna", "Boris", "Carla"]
780+-- > Only $ In ["Anna", "Boris", "Carla"]
748-- 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
749-- substituted instead, to ensure that your clause remains
783-- substituted instead, to ensure that your clause remains
@@ -771,7 +805,7 @@ fmtError msg q xs = throw FormatError {
771-- * There must be no other \"@?@\" characters anywhere in your
805-- * There must be no other \"@?@\" characters anywhere in your
772-- template.
806-- template.
774−-- * There must one or more \"@?@\" in the parentheses.
808+-- * There must be one or more \"@?@\" in the parentheses.
776-- * Extra white space is fine.
810-- * Extra white space is fine.
@@ -792,6 +826,22 @@ fmtError msg q xs = throw FormatError {
792-- > insert into users (first_name,last_name) values
826-- > insert into users (first_name,last_name) values
793-- > ('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")]
795-- $result
845-- $result
797-- 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
@@ -826,7 +876,7 @@ fmtError msg q xs = throw FormatError {
827-- 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
828-- types, Haskell cannot. If your result contains columns that may be
878-- types, Haskell cannot. If your result contains columns that may be
829−-- @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
832-- > (Text, Maybe Int, Int)
882-- > (Text, Maybe Int, Int)
@@ -852,7 +902,7 @@ fmtError msg q xs = throw FormatError {
852-- all values of the given PostgreSQL type is considered \"compatible\".
902-- all values of the given PostgreSQL type is considered \"compatible\".
853-- For instance, you can always extract a PostgreSQL 16-bit @SMALLINT@
903-- For instance, you can always extract a PostgreSQL 16-bit @SMALLINT@
854-- column to a Haskell 'Int'. The Haskell 'Float' type can accurately
904-- column to a Haskell 'Int'. The Haskell 'Float' type can accurately
855−-- represent a @SMALLINT@, so it is considered compatble with those types.
905+-- represent a @SMALLINT@, so it is considered compatible with those types.
857-- * 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
858-- column, /not/ on its values. For instance, a PostgreSQL 64-bit
908-- column, /not/ on its values. For instance, a PostgreSQL 64-bit
@@ -866,25 +916,3 @@ fmtError msg q xs = throw FormatError {
866-- 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
867-- wrong results. In such cases, write a @newtype@ wrapper and a
917-- wrong results. In such cases, write a @newtype@ wrapper and a
868-- custom 'Result' instance to handle your encoding.
918-- custom 'Result' instance to handle your encoding.
870−getTypename :: Connection -> PQ.Oid -> IO ByteString
871−getTypename conn@Connection{..} oid =
872− case oid2builtin oid of
873− Just builtin -> return $! builtin2typname builtin
874− Nothing -> modifyMVar connectionObjects $ \oidmap -> do
875− case IntMap.lookup (oid2int oid) oidmap of
876− Just name -> return (oidmap, name)
878− names <- query conn "SELECT typname FROM pg_type WHERE oid=?"
880− name <- case names of
881− [] -> return $ throw SqlError {
882− sqlNativeError = -1,
883− sqlErrorMsg = "invalid type oid",
886− [Only x] -> return x
887− _ -> fail "typename query returned more than one result"
888− -- oid is a primary key, so the query should
889− -- never return more than one result
890− return (IntMap.insert (oid2int oid) name oidmap, name)