@@ -1,18 +1,14 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
1+{-# LANGUAGE DeriveDataTypeable, RecordWildCards, NamedFieldPuns #-}
2−{-# LANGUAGE NamedFieldPuns #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE PatternGuards #-}
5−{-# LANGUAGE RecordWildCards #-}
6−{-# LANGUAGE ViewPatterns #-}
8------------------------------------------------------------------------------
3------------------------------------------------------------------------------
10-- Module: Database.PostgreSQL.Simple
5-- Module: Database.PostgreSQL.Simple
11-- Copyright: (c) 2011 MailRank, Inc.
6-- Copyright: (c) 2011 MailRank, Inc.
12−-- (c) 2011-2012 Leon P Smith
7+-- (c) 2011 Leon P Smith
13-- License: BSD3
8-- License: BSD3
14-- Maintainer: Leon P Smith <leon@melding-monads.com>
9-- Maintainer: Leon P Smith <leon@melding-monads.com>
15-- Stability: experimental
10-- Stability: experimental
11+-- Portability: portable
17-- A mid-level client library for the PostgreSQL database, aimed at ease of
13-- A mid-level client library for the PostgreSQL database, aimed at ease of
18-- use and high performance.
14-- use and high performance.
@@ -42,9 +38,6 @@ module Database.PostgreSQL.Simple
42 -- ** Modifying multiple rows at once
38 -- ** Modifying multiple rows at once
45− -- ** @RETURNING@: modifications that return results
48 -- * Extracting results
41 -- * Extracting results
49 -- $result
42 -- $result
@@ -55,35 +48,27 @@ module Database.PostgreSQL.Simple
57 -- * Types
50 -- * Types
58− Connection
52+ , Connection
63 , Binary(..)
55 , Binary(..)
64 , Only(..)
56 , Only(..)
65 , (:.)(..)
57 , (:.)(..)
66 -- ** Exceptions
58 -- ** Exceptions
67− , SomePostgreSqlException(..)
68 , SqlError(..)
59 , SqlError(..)
70− , FormatError(..)
60+ , FormatError(fmtMessage, fmtQuery, fmtParams)
71− , QueryError(..)
61+ , QueryError(qeMessage, qeQuery)
72− , ResultError(..)
62+ , ResultError(errSQLType, errHaskellType, errMessage)
73 -- * Connection management
63 -- * Connection management
74− , Base.connectPostgreSQL
76 , Base.connect
64 , Base.connect
77− , Base.withConnect
65+ , Base.connectPostgreSQL
78− , Base.ConnectInfo(..)
79− , Base.defaultConnectInfo
80 , Base.postgreSQLConnectionString
66 , Base.postgreSQLConnectionString
67+ , Base.defaultConnectInfo
81 -- * Queries that return results
69 -- * Queries that return results
84− -- ** Queries taking parser as argument
87 -- * Queries that stream results
72 -- * Queries that stream results
88 , FoldOptions(..)
73 , FoldOptions(..)
89 , FetchQuantity(..)
74 , FetchQuantity(..)
@@ -94,15 +79,6 @@ module Database.PostgreSQL.Simple
94 , foldWithOptions_
79 , foldWithOptions_
96 , forEach_
81 , forEach_
98− -- ** Queries that stream results taking a parser as an argument
100− , foldWithOptionsAndParser
102− , foldWithOptionsAndParser_
106 -- * Statements that do not return results
82 -- * Statements that do not return results
107 , execute
83 , execute
108 , execute_
84 , execute_
@@ -110,9 +86,18 @@ module Database.PostgreSQL.Simple
110-- , Base.insertID
86-- , Base.insertID
111 -- * Transaction handling
87 -- * Transaction handling
112 , withTransaction
88 , withTransaction
113− , withSavepoint
89+ , TransactionMode(..)
92+ , defaultTransactionMode
93+ , defaultIsolationLevel
94+ , defaultReadWriteMode
95+ , withTransactionLevel
96+ , withTransactionMode
114-- , Base.autocommit
97-- , Base.autocommit
117 , rollback
102 , rollback
118 -- * Helper functions
103 -- * Helper functions
@@ -120,27 +105,50 @@ module Database.PostgreSQL.Simple
120 , formatQuery
105 , formatQuery
123−import Data.ByteString.Builder (Builder, byteString, char8)
108+import Blaze.ByteString.Builder
109+ ( Builder, fromByteString, toByteString )
110+import Blaze.ByteString.Builder.Char8 (fromChar)
124−import Control.Applicative ((<$>))
111+import Control.Applicative ((<$>), pure)
125−import Control.Exception as E
112+import Control.Concurrent.MVar
113+import Control.Exception
114+ ( Exception, onException, throw, throwIO, finally )
115+import Control.Monad (foldM)
126import Data.ByteString (ByteString)
116import Data.ByteString (ByteString)
127import Data.Int (Int64)
117import Data.Int (Int64)
118+import qualified Data.IntMap as IntMap
128import Data.List (intersperse)
119import Data.List (intersperse)
129−import Data.Monoid (mconcat)
120+import Data.Monoid (mappend, mconcat)
121+import Data.Typeable (Typeable)
122+import Database.PostgreSQL.Simple.BuiltinTypes
123+ ( oid2builtin, builtin2typname )
130−import Database.PostgreSQL.Simple.Compat ((<>), toByteString)
124+import Database.PostgreSQL.Simple.Compat ( mask )
131−import Database.PostgreSQL.Simple.Cursor
132import Database.PostgreSQL.Simple.FromField (ResultError(..))
125import Database.PostgreSQL.Simple.FromField (ResultError(..))
133import Database.PostgreSQL.Simple.FromRow (FromRow(..))
126import Database.PostgreSQL.Simple.FromRow (FromRow(..))
134−import Database.PostgreSQL.Simple.ToField (Action(..))
127+import Database.PostgreSQL.Simple.Ok
128+import Database.PostgreSQL.Simple.ToField (Action(..), inQuotes)
135import Database.PostgreSQL.Simple.ToRow (ToRow(..))
129import Database.PostgreSQL.Simple.ToRow (ToRow(..))
136import Database.PostgreSQL.Simple.Types
130import Database.PostgreSQL.Simple.Types
137 ( Binary(..), In(..), Only(..), Query(..), (:.)(..) )
131 ( Binary(..), In(..), Only(..), Query(..), (:.)(..) )
138import Database.PostgreSQL.Simple.Internal as Base
132import Database.PostgreSQL.Simple.Internal as Base
139−import Database.PostgreSQL.Simple.Internal.PQResultUtils
140−import Database.PostgreSQL.Simple.Transaction
141import qualified Database.PostgreSQL.LibPQ as PQ
133import qualified Database.PostgreSQL.LibPQ as PQ
134+import Text.Regex.PCRE.Light (compile, caseless, match)
142import qualified Data.ByteString.Char8 as B
135import qualified Data.ByteString.Char8 as B
143−
136+import qualified Data.Text as T
137+import qualified Data.Text.Encoding as TE
138+import qualified Data.Vector as V
139+import Control.Monad.Trans.Reader
140+import Control.Monad.Trans.State.Strict
142+-- | Exception thrown if a 'Query' could not be formatted correctly.
143+-- This may occur if the number of \'@?@\' characters in the query
144+-- string does not match the number of parameters provided.
145+data FormatError = FormatError {
146+ fmtMessage :: String
148+ , fmtParams :: [ByteString]
149+ } deriving (Eq, Show, Typeable)
151+instance Exception FormatError
145-- | Format a query string.
153-- | Format a query string.
@@ -174,143 +182,56 @@ formatQuery conn q@(Query template) qs
174formatMany :: (ToRow q) => Connection -> Query -> [q] -> IO ByteString
182formatMany :: (ToRow q) => Connection -> Query -> [q] -> IO ByteString
175formatMany _ q [] = fmtError "no rows supplied" q []
183formatMany _ q [] = fmtError "no rows supplied" q []
176formatMany conn q@(Query template) qs = do
184formatMany conn q@(Query template) qs = do
177− case parseTemplate template of
185+ case match re template [] of
178− Just (before, qbits, after) -> do
186+ Just [_,before,qbits,after] -> do
179 bs <- mapM (buildQuery conn q qbits . toRow) qs
187 bs <- mapM (buildQuery conn q qbits . toRow) qs
180− return . toByteString . mconcat $ byteString before :
188+ return . toByteString . mconcat $ fromByteString before :
181− intersperse (char8 ',') bs ++
189+ intersperse (fromChar ',') bs ++
182− [byteString after]
190+ [fromByteString after]
183− Nothing -> fmtError "syntax error in multi-row template" q []
191+ _ -> error "foo"
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
204− -- Search for the next occurrence of "VALUES"
193+ re = compile "^([^?]+\\bvalues\\s*)\
205− search bs =
194+ \(\\(\\s*[?](?:\\s*,\\s*[?])*\\s*\\))\
206− case B.breakSubstring "VALUES" bs of
195+ \([^?]*)$"
207− (x, y)
196+ [caseless]
208− -- If "VALUES" is not present in the string, or any '?' characters
197+
209− -- were encountered prior to it, fail.
198+escapeStringConn :: Connection -> ByteString -> IO (Either ByteString ByteString)
210− | B.null y || ('?' `B.elem` x)
199+escapeStringConn conn s =
211− -> Nothing
200+ withConnection conn $ \c ->
212−
201+ PQ.escapeStringConn c s >>= checkError c
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
203+escapeByteaConn :: Connection -> ByteString -> IO (Either ByteString ByteString)
204+escapeByteaConn conn s =
205+ withConnection conn $ \c ->
206+ PQ.escapeByteaConn c s >>= checkError c
208+checkError :: PQ.Connection -> Maybe a -> IO (Either ByteString a)
209+checkError _ (Just x) = return $ Right x
210+checkError c Nothing = Left . maybe "" id <$> PQ.errorMessage c
281buildQuery :: Connection -> Query -> ByteString -> [Action] -> IO Builder
212buildQuery :: Connection -> Query -> ByteString -> [Action] -> IO Builder
282−buildQuery conn q template xs =
213+buildQuery conn q template xs = zipParams (split template) <$> mapM sub xs
283− zipParams (split template) <$> mapM (buildAction conn q xs) xs
214+ where quote = either (\msg -> fmtError (utf8ToString msg) q xs)
284− where split s =
215+ (inQuotes . fromByteString)
285− -- This part escapes double '??'s to make literal '?'s possible
216+ utf8ToString = T.unpack . TE.decodeUtf8
286− -- in PostgreSQL queries using the JSON operators: @?@, @?|@ and @?&@
217+ sub (Plain b) = pure b
287− let (h,t) = breakOnSingleQuestionMark s
218+ sub (Escape s) = quote <$> escapeStringConn conn s
288− in byteString h
219+ sub (EscapeBytea s) = quote <$> escapeByteaConn conn s
289− : if B.null t
220+ sub (Many ys) = mconcat <$> mapM sub ys
291− else split (B.tail t)
221+ split s = fromByteString h : if B.null t then [] else split (B.tail t)
222+ where (h,t) = B.break (=='?') s
292− zipParams (t:ts) (p:ps) = t <> p <> zipParams ts ps
223+ zipParams (t:ts) (p:ps) = t `mappend` p `mappend` zipParams ts ps
293 zipParams [t] [] = t
224 zipParams [t] [] = t
294− zipParams _ _ = fmtError (show countSingleQs ++
225+ zipParams _ _ = fmtError (show (B.count '?' template) ++
295− " single '?' characters, but " ++
226+ " '?' characters, but " ++
296 show (length xs) ++ " parameters") q xs
227 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
307-- | Execute an @INSERT@, @UPDATE@, or other SQL query that is not
229-- | Execute an @INSERT@, @UPDATE@, or other SQL query that is not
308-- expected to return results.
230-- expected to return results.
310-- Returns the number of rows affected.
232-- Returns the number of rows affected.
312−-- Throws 'FormatError' if the query could not be formatted correctly, or
234+-- Throws 'FormatError' if the query could not be formatted correctly.
313−-- a 'SqlError' exception if the backend returns an error.
314execute :: (ToRow q) => Connection -> Query -> q -> IO Int64
235execute :: (ToRow q) => Connection -> Query -> q -> IO Int64
315execute conn template qs = do
236execute conn template qs = do
316 result <- exec conn =<< formatQuery conn template qs
237 result <- exec conn =<< formatQuery conn template qs
@@ -319,61 +240,15 @@ execute conn template qs = do
319-- | Execute a multi-row @INSERT@, @UPDATE@, or other SQL query that is not
240-- | Execute a multi-row @INSERT@, @UPDATE@, or other SQL query that is not
320-- expected to return results.
241-- expected to return results.
322−-- Returns the number of rows affected. If the list of parameters is empty,
243+-- Returns the number of rows affected.
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.
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:
340−-- @
245+-- Throws 'FormatError' if the query could not be formatted correctly.
341−-- executeMany c [sql|
344−-- FROM (VALUES (?,?)) as upd(x,y)
345−-- WHERE sometable.x = upd.x
346−-- |] [(1, \"hello\"),(2, \"world\")]
349executeMany :: (ToRow q) => Connection -> Query -> [q] -> IO Int64
246executeMany :: (ToRow q) => Connection -> Query -> [q] -> IO Int64
350executeMany _ _ [] = return 0
247executeMany _ _ [] = return 0
351executeMany conn q qs = do
248executeMany conn q qs = do
352 result <- exec conn =<< formatMany conn q qs
249 result <- exec conn =<< formatMany conn q qs
353 finishExecute conn q result
250 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.
367−returning :: (ToRow q, FromRow r) => Connection -> Query -> [q] -> IO [r]
368−returning = returningWith fromRow
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
377-- | Perform a @SELECT@ or other SQL query that is expected to return
252-- | Perform a @SELECT@ or other SQL query that is expected to return
378-- results. All results are retrieved and converted before this
253-- results. All results are retrieved and converted before this
379-- function returns.
254-- function returns.
@@ -389,27 +264,17 @@ returningWith parser conn q qs = do
389-- using 'execute' instead of 'query').
264-- using 'execute' instead of 'query').
391-- * 'ResultError': result conversion failed.
266-- * 'ResultError': result conversion failed.
393−-- * 'SqlError': the postgresql backend returned an error, e.g.
394−-- a syntax or type error, or an incorrect table or column name.
395−query :: (ToRow q, FromRow r) => Connection -> Query -> q -> IO [r]
267+query :: (ToRow q, FromRow r)
396−query = queryWith fromRow
268+ => Connection -> Query -> q -> IO [r]
269+query conn template qs = do
270+ result <- exec conn =<< formatQuery conn template qs
271+ finishQuery conn template result
398-- | A version of 'query' that does not perform query substitution.
273-- | A version of 'query' that does not perform query substitution.
399query_ :: (FromRow r) => Connection -> Query -> IO [r]
274query_ :: (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]
410−queryWith_ parser conn q@(Query que) = do
275+query_ conn q@(Query que) = do
411 result <- exec conn que
276 result <- exec conn que
412− finishQueryWith parser conn q result
277+ finishQuery conn q result
414-- | Perform a @SELECT@ or other SQL query that is expected to return
279-- | Perform a @SELECT@ or other SQL query that is expected to return
415-- results. Results are streamed incrementally from the server, and
280-- results. Results are streamed incrementally from the server, and
@@ -421,12 +286,6 @@ queryWith_ parser conn q@(Query que) = do
421-- This fold is /not/ strict. The stream consumer is responsible for
286-- This fold is /not/ strict. The stream consumer is responsible for
422-- forcing the evaluation of its result to avoid space leaks.
287-- 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.
430-- Exceptions that may be thrown:
289-- Exceptions that may be thrown:
432-- * 'FormatError': the query string could not be formatted correctly.
291-- * 'FormatError': the query string could not be formatted correctly.
@@ -435,9 +294,7 @@ queryWith_ parser conn q@(Query que) = do
435-- using 'execute' instead of 'query').
294-- using 'execute' instead of 'query').
437-- * 'ResultError': result conversion failed.
296-- * '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.
441fold :: ( FromRow row, ToRow params )
298fold :: ( FromRow row, ToRow params )
442 => Connection
299 => Connection
@@ -447,20 +304,6 @@ fold :: ( FromRow row, ToRow params )
448fold = foldWithOptions defaultFoldOptions
305fold = 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.
464data FetchQuantity
307data FetchQuantity
465 = Automatic
308 = Automatic
466 | Fixed !Int
309 | Fixed !Int
@@ -471,19 +314,12 @@ data FoldOptions
471 transactionMode :: !TransactionMode
314 transactionMode :: !TransactionMode
474−-- | defaults to 'Automatic', and 'TransactionMode' 'ReadCommitted' 'ReadOnly'
475defaultFoldOptions :: FoldOptions
317defaultFoldOptions :: FoldOptions
476defaultFoldOptions = FoldOptions {
318defaultFoldOptions = FoldOptions {
477 fetchQuantity = Automatic,
319 fetchQuantity = Automatic,
478 transactionMode = TransactionMode ReadCommitted ReadOnly
320 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.
487foldWithOptions :: ( FromRow row, ToRow params )
323foldWithOptions :: ( FromRow row, ToRow params )
488 => FoldOptions
324 => FoldOptions
489 -> Connection
325 -> Connection
@@ -492,21 +328,9 @@ foldWithOptions :: ( FromRow row, ToRow params )
493 -> (a -> row -> IO a)
329 -> (a -> row -> IO a)
495−foldWithOptions opts = foldWithOptionsAndParser opts fromRow
331+foldWithOptions opts conn template qs a f = do
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
508 q <- formatQuery conn template qs
332 q <- formatQuery conn template qs
509− doFold opts parser conn template (Query q) a f
333+ doFold opts conn template (Query q) a f
511-- | A version of 'fold' that does not perform query substitution.
335-- | A version of 'fold' that does not perform query substitution.
512fold_ :: (FromRow r) =>
336fold_ :: (FromRow r) =>
@@ -517,14 +341,6 @@ fold_ :: (FromRow r) =>
518fold_ = foldWithOptions_ defaultFoldOptions
342fold_ = foldWithOptions_ defaultFoldOptions
520−-- | A version of 'fold_' taking a parser as an argument
521−foldWith_ :: RowParser r
527−foldWith_ = foldWithOptionsAndParser_ defaultFoldOptions
529foldWithOptions_ :: (FromRow r) =>
345foldWithOptions_ :: (FromRow r) =>
530 FoldOptions
346 FoldOptions
@@ -533,27 +349,18 @@ foldWithOptions_ :: (FromRow r) =>
533 -> a -- ^ Initial state for result consumer.
349 -> a -- ^ Initial state for result consumer.
534 -> (a -> r -> IO a) -- ^ Result consumer.
350 -> (a -> r -> IO a) -- ^ Result consumer.
536−foldWithOptions_ opts conn query' a f = doFold opts fromRow conn query' query' a f
352+foldWithOptions_ opts conn query a f = doFold opts conn query query a f
538−-- | A version of 'foldWithOptions_' taking a parser as an argument
354+
539−foldWithOptionsAndParser_ :: FoldOptions
355+doFold :: ( FromRow row )
540− -> RowParser r
356+ => 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
550 -> Connection
357 -> Connection
554 -> (a -> row -> IO a)
361 -> (a -> row -> IO a)
556−doFold FoldOptions{..} parser conn _template q a0 f = do
363+doFold FoldOptions{..} conn _template q a f = do
557 stat <- withConnection conn PQ.transactionStatus
364 stat <- withConnection conn PQ.transactionStatus
558 case stat of
365 case stat of
559 PQ.TransIdle -> withTransactionMode transactionMode conn go
366 PQ.TransIdle -> withTransactionMode transactionMode conn go
@@ -571,17 +378,11 @@ doFold FoldOptions{..} parser conn _template q a0 f = do
571 PQ.TransUnknown -> fail "foldWithOpts FIXME: PQ.TransUnknown"
378 PQ.TransUnknown -> fail "foldWithOpts FIXME: PQ.TransUnknown"
572 -- Not sure what this means.
379 -- Not sure what this means.
574− declare =
381+ go = do
575− declareCursor conn q
382+ -- FIXME: what about name clashes with already-declared cursors?
576− fetch cursor a =
383+ _ <- execute_ conn ("DECLARE fold NO SCROLL CURSOR FOR "
577− foldForwardWithParser cursor parser chunkSize f a
384+ `mappend` q)
578−
385+ loop a `finally` execute_ conn "CLOSE fold"
579− go = bracket declare closeCursor $ \cursor ->
580− let loop a = fetch cursor a >>=
586-- FIXME: choose the Automatic chunkSize more intelligently
387-- FIXME: choose the Automatic chunkSize more intelligently
587-- One possibility is to use the type of the results, although this
388-- One possibility is to use the type of the results, although this
@@ -592,6 +393,9 @@ doFold FoldOptions{..} parser conn _template q a0 f = do
592 chunkSize = case fetchQuantity of
393 chunkSize = case fetchQuantity of
593 Automatic -> 256
394 Automatic -> 256
594 Fixed n -> n
395 Fixed n -> n
397+ rs <- query conn "FETCH FORWARD ? FROM fold" (Only chunkSize)
398+ if null rs then return a else foldM f a rs >>= loop
596-- | A version of 'fold' that does not transform a state value.
400-- | A version of 'fold' that does not transform a state value.
597forEach :: (ToRow q, FromRow r) =>
401forEach :: (ToRow q, FromRow r) =>
@@ -600,37 +404,188 @@ forEach :: (ToRow q, FromRow r) =>
600 -> q -- ^ Query parameters.
404 -> q -- ^ Query parameters.
601 -> (r -> IO ()) -- ^ Result consumer.
405 -> (r -> IO ()) -- ^ Result consumer.
603−forEach = forEachWith fromRow
407+forEach conn template qs = fold conn template qs () . const
604{-# INLINE forEach #-}
408{-# 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 #-}
617-- | A version of 'forEach' that does not perform query substitution.
410-- | A version of 'forEach' that does not perform query substitution.
618forEach_ :: (FromRow r) =>
411forEach_ :: (FromRow r) =>
619 Connection
412 Connection
620 -> Query -- ^ Query template.
413 -> Query -- ^ Query template.
621 -> (r -> IO ()) -- ^ Result consumer.
414 -> (r -> IO ()) -- ^ Result consumer.
623−forEach_ = forEachWith_ fromRow
416+forEach_ conn template = fold_ conn template () . const
624{-# INLINE forEach_ #-}
417{-# INLINE forEach_ #-}
626−forEachWith_ :: RowParser r
419+forM' :: (Ord n, Num n) => n -> n -> (n -> IO a) -> IO [a]
627− -> Connection
420+forM' lo hi m = loop hi []
629− -> (r -> IO ())
422+ loop !n !as
630− -> IO ()
423+ | n < lo = return as
631−forEachWith_ parser conn template = foldWith_ parser conn template () . const
424+ | otherwise = do
632−{-# INLINE forEachWith_ #-}
425+ a <- m n
633−
426+ loop (n-1) (a:as)
428+finishQuery :: (FromRow r) => Connection -> Query -> PQ.Result -> IO [r]
429+finishQuery conn q result = do
430+ status <- PQ.resultStatus result
433+ throwIO $ QueryError "query: Empty query" q
435+ throwIO $ QueryError "query resulted in a command response" q
437+ ncols <- PQ.nfields result
438+ let unCol (PQ.Col x) = fromIntegral x :: Int
439+ typenames <- V.generateM (unCol ncols)
440+ (\(PQ.Col . fromIntegral -> col) -> do
441+ getTypename conn =<< PQ.ftype result col)
442+ nrows <- PQ.ntuples result
443+ ncols <- PQ.nfields result
444+ forM' 0 (nrows-1) $ \row -> do
445+ let rw = Row row typenames result
446+ case runStateT (runReaderT (unRP fromRow) rw) 0 of
447+ Ok (val,col) | col == ncols -> return val
449+ vals <- forM' 0 (ncols-1) $ \c -> do
450+ v <- PQ.getvalue result row c
451+ return ( typenames V.! unCol c
453+ throw (ConversionFailed
454+ (show (unCol ncols) ++ " values: " ++ show vals)
455+ (show (unCol col) ++ " slots in target type")
456+ "mismatch between number of columns to \
457+ \convert and number in target type")
458+ Errors [] -> throwIO $ ConversionFailed "" "" "unknown error"
459+ Errors [x] -> throwIO x
460+ Errors xs -> throwIO $ ManyErrors xs
462+ throwIO $ QueryError "query: COPY TO is not supported" q
464+ throwIO $ QueryError "query: COPY FROM is not supported" q
465+ PQ.BadResponse -> throwResultError "query" result status
466+ PQ.NonfatalError -> throwResultError "query" result status
467+ PQ.FatalError -> throwResultError "query" result status
469+ellipsis :: ByteString -> ByteString
471+ | B.length bs > 15 = B.take 10 bs `B.append` "[...]"
475+-- | Of the four isolation levels defined by the SQL standard,
476+-- these are the three levels distinguished by PostgreSQL as of version 9.0.
477+-- See <http://www.postgresql.org/docs/9.1/static/transaction-iso.html>
478+-- for more information. Note that prior to PostgreSQL 9.0, 'RepeatableRead'
479+-- was equivalent to 'Serializable'.
482+ = DefaultIsolationLevel -- ^ the isolation level will be taken from
483+ -- PostgreSQL's per-connection
484+ -- @default_transaction_isolation@ variable,
485+ -- which is initialized according to the
486+ -- server's config. The default configuration
487+ -- is 'ReadCommitted'.
491+ deriving (Show, Eq, Ord, Enum, Bounded)
494+ = DefaultReadWriteMode -- ^ the read-write mode will be taken from
495+ -- PostgreSQL's per-connection
496+ -- @default_transaction_read_only@ variable,
497+ -- which is initialized according to the
498+ -- server's config. The default configuration
502+ deriving (Show, Eq, Ord, Enum, Bounded)
504+data TransactionMode = TransactionMode {
505+ isolationLevel :: !IsolationLevel,
506+ readWriteMode :: !ReadWriteMode
507+ } deriving (Show, Eq)
509+defaultTransactionMode :: TransactionMode
510+defaultTransactionMode = TransactionMode
511+ defaultIsolationLevel
512+ defaultReadWriteMode
514+defaultIsolationLevel :: IsolationLevel
515+defaultIsolationLevel = DefaultIsolationLevel
517+defaultReadWriteMode :: ReadWriteMode
518+defaultReadWriteMode = DefaultReadWriteMode
520+-- | Execute an action inside a SQL transaction.
522+-- This function initiates a transaction with a \"@begin
523+-- transaction@\" statement, then executes the supplied action. If
524+-- the action succeeds, the transaction will be completed with
525+-- 'Base.commit' before this function returns.
527+-- If the action throws /any/ kind of exception (not just a
528+-- PostgreSQL-related exception), the transaction will be rolled back using
529+-- 'rollback', then the exception will be rethrown.
530+withTransaction :: Connection -> IO a -> IO a
531+withTransaction = withTransactionMode defaultTransactionMode
533+-- | Execute an action inside a SQL transaction with a given isolation level.
534+withTransactionLevel :: IsolationLevel -> Connection -> IO a -> IO a
535+withTransactionLevel lvl
536+ = withTransactionMode defaultTransactionMode { isolationLevel = lvl }
538+-- | Execute an action inside a SQL transaction with a given transaction mode.
539+withTransactionMode :: TransactionMode -> Connection -> IO a -> IO a
540+withTransactionMode mode conn act =
541+ mask $ \restore -> do
543+ r <- restore act `onException` rollback conn
547+-- | Rollback a transaction.
548+rollback :: Connection -> IO ()
549+rollback conn = execute_ conn "ABORT" >> return ()
551+-- | Commit a transaction.
552+commit :: Connection -> IO ()
553+commit conn = execute_ conn "COMMIT" >> return ()
555+-- | Begin a transaction.
556+begin :: Connection -> IO ()
557+begin = beginMode defaultTransactionMode
559+-- | Begin a transaction with a given isolation level
560+beginLevel :: IsolationLevel -> Connection -> IO ()
561+beginLevel lvl = beginMode defaultTransactionMode { isolationLevel = lvl }
563+-- | Begin a transaction with a given transaction mode
564+beginMode :: TransactionMode -> Connection -> IO ()
565+beginMode mode conn = do
566+ _ <- execute_ conn $! Query (B.concat ["BEGIN", isolevel, readmode])
569+ isolevel = case isolationLevel mode of
570+ DefaultIsolationLevel -> ""
571+ ReadCommitted -> " ISOLATION LEVEL READ COMMITTED"
572+ RepeatableRead -> " ISOLATION LEVEL REPEATABLE READ"
573+ Serializable -> " ISOLATION LEVEL SERIALIZABLE"
574+ readmode = case readWriteMode mode of
575+ DefaultReadWriteMode -> ""
576+ ReadWrite -> " READ WRITE"
577+ ReadOnly -> " READ ONLY"
579+fmtError :: String -> Query -> [Action] -> a
580+fmtError msg q xs = throw FormatError {
583+ , fmtParams = map twiddle xs
585+ where twiddle (Plain b) = toByteString b
586+ twiddle (Escape s) = s
587+ twiddle (EscapeBytea s) = s
588+ twiddle (Many ys) = B.concat (map twiddle ys)
@@ -658,11 +613,9 @@ forEachWith_ parser conn template = foldWith_ parser conn template () . const
659-- > import Database.PostgreSQL.Simple
614-- > import Database.PostgreSQL.Simple
662-- > hello = do
616-- > hello = do
663−-- > conn <- connectPostgreSQL ""
617+-- > conn <- connect defaultConnectInfo
664−-- > [Only i] <- query_ conn "select 2 + 2"
618+-- > query conn "select 2 + 2"
667-- A 'Query' value does not represent the actual query that will be
620-- A 'Query' value does not represent the actual query that will be
668-- executed, but is a template for constructing the final query.
621-- executed, but is a template for constructing the final query.
@@ -723,30 +676,15 @@ forEachWith_ parser conn template = foldWith_ parser conn template () . const
723-- The same kind of problem can arise with string literals if you have
676-- The same kind of problem can arise with string literals if you have
724-- the @OverloadedStrings@ language extension enabled. Again, just
677-- the @OverloadedStrings@ language extension enabled. Again, just
725-- use an explicit type signature if this happens.
678-- 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])
741-- $only_param
680-- $only_param
743-- Haskell lacks a single-element tuple type, so if you have just one
682-- Haskell lacks a single-element tuple type, so if you have just one
744−-- value you want substituted into a query or a single-column result,
683+-- value you want substituted into a query, what should you do?
745−-- what should you do?
747-- The obvious approach would appear to be something like this:
685-- The obvious approach would appear to be something like this:
749−-- > instance (ToField a) => ToRow a where
687+-- > instance (Param a) => QueryParam a where
752-- Unfortunately, this wreaks havoc with type inference, so we take a
690-- Unfortunately, this wreaks havoc with type inference, so we take a
@@ -757,9 +695,6 @@ forEachWith_ parser conn template = foldWith_ parser conn template () . const
758-- > execute conn "insert into users (first_name) values (?)"
696-- > execute conn "insert into users (first_name) values (?)"
759-- > ["Nuala"]
697-- > ["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.
@@ -777,7 +712,7 @@ forEachWith_ parser conn template = foldWith_ parser conn template () . const
777-- Here's an example:
712-- Here's an example:
779-- > query conn "select * from users where first_name in ?" $
714-- > query conn "select * from users where first_name in ?" $
780−-- > Only $ In ["Anna", "Boris", "Carla"]
715+-- > In ["Anna", "Boris", "Carla"]
782-- If your 'In'-wrapped list is empty, the string @\"(null)\"@ will be
717-- If your 'In'-wrapped list is empty, the string @\"(null)\"@ will be
783-- substituted instead, to ensure that your clause remains
718-- substituted instead, to ensure that your clause remains
@@ -805,7 +740,7 @@ forEachWith_ parser conn template = foldWith_ parser conn template () . const
805-- * There must be no other \"@?@\" characters anywhere in your
740-- * There must be no other \"@?@\" characters anywhere in your
806-- template.
741-- template.
808−-- * There must be one or more \"@?@\" in the parentheses.
743+-- * There must one or more \"@?@\" in the parentheses.
810-- * Extra white space is fine.
745-- * Extra white space is fine.
@@ -826,22 +761,6 @@ forEachWith_ parser conn template = foldWith_ parser conn template () . const
826-- > insert into users (first_name,last_name) values
761-- > insert into users (first_name,last_name) values
827-- > ('Boris','Karloff'),('Ed','Wood')
762-- > ('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")]
845-- $result
764-- $result
847-- The 'query' and 'query_' functions return a list of values in the
766-- The 'query' and 'query_' functions return a list of values in the
@@ -876,7 +795,7 @@ forEachWith_ parser conn template = foldWith_ parser conn template () . const
877-- Although SQL can accommodate @NULL@ as a value for any of these
796-- Although SQL can accommodate @NULL@ as a value for any of these
878-- types, Haskell cannot. If your result contains columns that may be
797-- types, Haskell cannot. If your result contains columns that may be
879−-- @NULL@, be sure that you use 'Maybe' in those positions of your
798+-- @NULL@, be sure that you use 'Maybe' in those positions of of your
882-- > (Text, Maybe Int, Int)
801-- > (Text, Maybe Int, Int)
@@ -902,7 +821,7 @@ forEachWith_ parser conn template = foldWith_ parser conn template () . const
902-- all values of the given PostgreSQL type is considered \"compatible\".
821-- all values of the given PostgreSQL type is considered \"compatible\".
903-- For instance, you can always extract a PostgreSQL 16-bit @SMALLINT@
822-- For instance, you can always extract a PostgreSQL 16-bit @SMALLINT@
904-- column to a Haskell 'Int'. The Haskell 'Float' type can accurately
823-- column to a Haskell 'Int'. The Haskell 'Float' type can accurately
905−-- represent a @SMALLINT@, so it is considered compatible with those types.
824+-- represent a @SMALLINT@, so it is considered compatble with those types.
907-- * A numeric compatibility check is based only on the type of a
826-- * A numeric compatibility check is based only on the type of a
908-- column, /not/ on its values. For instance, a PostgreSQL 64-bit
827-- column, /not/ on its values. For instance, a PostgreSQL 64-bit
@@ -916,3 +835,25 @@ forEachWith_ parser conn template = foldWith_ parser conn template () . const
916-- UTF-8. If you use some other encoding, decoding may fail or give
835-- UTF-8. If you use some other encoding, decoding may fail or give
917-- wrong results. In such cases, write a @newtype@ wrapper and a
836-- wrong results. In such cases, write a @newtype@ wrapper and a
918-- custom 'Result' instance to handle your encoding.
837-- custom 'Result' instance to handle your encoding.
839+getTypename :: Connection -> PQ.Oid -> IO ByteString
840+getTypename conn@Connection{..} oid =
841+ case oid2builtin oid of
842+ Just builtin -> return $! builtin2typname builtin
843+ Nothing -> modifyMVar connectionObjects $ \oidmap -> do
844+ case IntMap.lookup (oid2int oid) oidmap of
845+ Just name -> return (oidmap, name)
847+ names <- query conn "SELECT typname FROM pg_type WHERE oid=?"
849+ name <- case names of
850+ [] -> return $ throw SqlError {
851+ sqlNativeError = -1,
852+ sqlErrorMsg = "invalid type oid",
855+ [Only x] -> return x
856+ _ -> fail "typename query returned more than one result"
857+ -- oid is a primary key, so the query should
858+ -- never return more than one result
859+ return (IntMap.insert (oid2int oid) name oidmap, name)