diff --git a/COPYRIGHT b/COPYRIGHT --- a/COPYRIGHT +++ b/COPYRIGHT @@ -1,4 +1,4 @@ -Copyright (C) 2005 John Goerzen +Copyright (C) 2005-2007 John Goerzen This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public diff --git a/Database/HDBC.hs b/Database/HDBC.hs --- a/Database/HDBC.hs +++ b/Database/HDBC.hs @@ -19,7 +19,7 @@ {- | Module : Database.HDBC - Copyright : Copyright (C) 2005-2006 John Goerzen + Copyright : Copyright (C) 2005-2007 John Goerzen License : GNU LGPL, version 2.1 or above Maintainer : John Goerzen @@ -46,9 +46,12 @@ SqlValue(..), -- * Database Connections - Connection, disconnect, clone, + IConnection, + disconnect, clone, + -- ** Wrapped Connections + ConnWrapper, withWConn, -- ** Preparing Queries - run, sRun, prepare, quickQuery, + run, sRun, prepare, quickQuery', quickQuery, -- ** Transaction Handling -- $transactions @@ -64,9 +67,10 @@ -- ** Execution execute, sExecute, executeMany, sExecuteMany, -- ** Fetching Results - fetchRow, fetchRowAL, fetchRowMap, - sFetchRow, fetchAllRows, fetchAllRowsAL, fetchAllRowsMap, - sFetchAllRows, getColumnNames, + fetchRow, fetchRowAL, fetchRowMap, sFetchRow, + fetchAllRows, fetchAllRows', fetchAllRowsAL, fetchAllRowsAL', + fetchAllRowsMap, fetchAllRowsMap', sFetchAllRows, sFetchAllRows', + getColumnNames, -- ** Statement Inquires describeResult, -- ** Miscellaneous @@ -93,9 +97,12 @@ import Database.HDBC.Utils(catchSql, handleSql, sqlExceptions, handleSqlError, withTransaction, sFetchAllRows, fetchAllRows, + sFetchAllRows', fetchAllRows', sRun, sExecute, sExecuteMany, sFetchRow, quickQuery, fetchRowMap, fetchAllRowsMap, - fetchRowAL, fetchAllRowsAL) + quickQuery', fetchAllRowsMap', + fetchRowAL, fetchAllRowsAL, + fetchAllRowsAL') import Database.HDBC.Types import Database.HDBC.ColTypes @@ -153,30 +160,30 @@ Here is a list of known drivers as of March 28, 2006: -[@Sqlite v3@] Available from . Or, to +[@Sqlite v3@] Available from . Or, to participate in development, use @darcs get --partial @ -[@PostgreSQL@] Available from . Or, to +[@PostgreSQL@] Available from . Or, to participate in development, use @darcs get --partial @ -[@ODBC@] Available from . Or, to +[@ODBC@] Available from . Or, to partitipace in development, use @darcs get --partial @ [@MySQL@] MySQL users are encouraged to use the ODBC driver, which works and has been tested against MySQL on both Linux\/Unix and Windows platforms. -In addition, there is one integration package: /hdbc-missingh/. This -integrates with the MissingH library . -Among other things, it lets any HDBC database act as a backend for the -AnyDBM interface. Available from . Or, +In addition, there is one integration package: /hdbc-anydbm/. This +integrates with the AnyDBM library . +It lets any HDBC database act as a backend for the +AnyDBM interface. Available from . Or, to participate in development, use -@darcs get --partial @ +@darcs get --partial @ The latest version of HDBC itself is available from -. Or, to participate in development, use +. Or, to participate in development, use @darcs get --partial @. -} @@ -248,7 +255,7 @@ -} {- $legal -Copyright (C) 2005-2006 John Goerzen +Copyright (C) 2005-2007 John Goerzen This library is free software; you can redistribute it and\/or modify it under the terms of the GNU Lesser General Public diff --git a/Database/HDBC/Statement.hs b/Database/HDBC/Statement.hs new file mode 100644 --- /dev/null +++ b/Database/HDBC/Statement.hs @@ -0,0 +1,482 @@ +module Database.HDBC.Statement + ( + Statement(..), + SqlError(..), + SqlType(..), nToSql, iToSql, + SqlValue(..) + ) + +where +import Data.Dynamic +import qualified Data.ByteString as B +import Data.Char(ord,toUpper) +import Data.Word +import Data.Int +import System.Time +import Database.HDBC.ColTypes + +data Statement = Statement + { + {- | Execute the prepared statement, passing in the given positional + parameters (that should take the place of the question marks + in the call to 'prepare'). + + For non-SELECT queries, the return value is the number of + rows modified, if known. If no rows were modified, you get 0. + If the value is unknown, you get -1. All current HDBC drivers + support this function and should never return -1. + + For SELECT queries, you will always get 0. + + This function should automatically call finish() to finish the previous + execution, if necessary. + -} + execute :: [SqlValue] -> IO Integer, + + {- | Execute the query with many rows. + The return value is the return value from the final row + as if you had called 'execute' on it. + + Due to optimizations that are possible due to different + databases and driver designs, this can often be significantly + faster than using 'execute' multiple times since queries + need to be compiled only once. + + This is most useful for non-SELECT statements. -} + executeMany :: [[SqlValue]] -> IO (), + + {- | Abort a query in progress -- usually not needed. -} + finish :: IO (), + + {- | Fetches one row from the DB. Returns 'Nothing' if there + are no more rows. Will automatically call 'finish' when + the last row is read. -} + fetchRow :: IO (Maybe [SqlValue]), + + {- | Returns a list of the column names in the result. + For maximum portability, you should not assume that + information is available until after an 'execute' function + has been run. + + Information is returned here directly as returned + by the underlying database layer. Note that different + databases have different rules about capitalization + of return values and about representation of names + of columns that are not simple columns. For this reason, + it is suggested that you treat this information for + display purposes only. Failing that, you should convert + to lower (or upper) case, and use @AS@ clauses for + anything other than simple columns. + + A simple getColumnNames implementation could simply + apply @map fst@ to the return value of 'describeResult'. + -} + getColumnNames :: IO [String], + + + {- | The original query that this 'Statement' was prepared + with. -} + originalQuery :: String, + {- | Obtain information about the columns in the result set. + Must be run only after 'execute'. The String in the result + set is the column name. + + You should expect this to be returned in the same manner + as a result from 'Database.HDBC.fetchAllRows''. + + All results should be converted to lowercase for you + before you see them. + + Please see caveats under 'getColumnNames' for information + on the column name field here. + -} + describeResult :: IO [(String, SqlColDesc)] + } + +{- | The main HDBC exception object. As much information as possible +is passed from the database through to the application through this object. + +Errors generated in the Haskell layer will have seNativeError set to -1. +-} +data SqlError = SqlError {seState :: String, + seNativeError :: Int, + seErrorMsg :: String} + deriving (Eq, Show, Read) + +sqlErrorTc :: TyCon +sqlErrorTc = mkTyCon "Database.HDBC.SqlError" + +instance Typeable SqlError where + typeOf _ = mkTyConApp sqlErrorTc [] + +{- | Conversions to and from 'SqlValue's and standard Haskell types. + +Conversions are powerful; for instance, you can call 'fromSql' on a SqlInt32 +and get a String or a Double out of it. This class attempts to Do +The Right Thing whenever possible, and will raise an error when asked to +do something incorrect. In particular, when converting to any type +except a Maybe, 'SqlNull' as the input will cause an error to be raised. + +Here are some notes about conversion: + + * Fractions of a second are not preserved on time values + +See also 'nToSql', 'iToSql'. +-} + +class (Show a) => SqlType a where + toSql :: a -> SqlValue + fromSql :: SqlValue -> a + +{- | Converts any Integral type to a 'SqlValue' by using toInteger. -} +nToSql :: Integral a => a -> SqlValue +nToSql n = SqlInteger (toInteger n) + +{- | Convenience function for using numeric literals in your program. -} +iToSql :: Int -> SqlValue +iToSql = toSql + +{- | The main type for expressing Haskell values to SQL databases. + +This type is used to marshall Haskell data to and from database APIs. +HDBC driver interfaces will do their best to use the most accurate and +efficient way to send a particular value to the database server. + +Values read back from the server are put in the most appropriate 'SqlValue' +type. 'fromSql' can then be used to convert them into whatever type +is needed locally in Haskell. + +Most people will use 'toSql' and 'fromSql' instead of manipulating +'SqlValue's directly. + +The default representation of time values is an integer number of seconds. +Databases such as PostgreSQL with builtin timestamp types can will see +automatic conversion between these Haskell types to local types. Other +databases can just use an int or a string. + +This behavior also exists for other types. For instance, many databases don't +have a Rational type, so they'll just use Haskell's show function and +store a Rational as a string. + +Two SqlValues are considered to be equal if one of these hold (first one that +is true holds; if none are true, they are not equal): + * Both are NULL + * Both represent the same type and the encapsulated values are equal + * The values of each, when converted to a string, are equal. -} +data SqlValue = SqlString String + | SqlByteString B.ByteString + | SqlWord32 Word32 + | SqlWord64 Word64 + | SqlInt32 Int32 + | SqlInt64 Int64 + | SqlInteger Integer + | SqlChar Char + | SqlBool Bool + | SqlDouble Double + | SqlRational Rational + | SqlEpochTime Integer -- ^ Representation of ClockTime or CalendarTime + | SqlTimeDiff Integer -- ^ Representation of TimeDiff + | SqlNull -- ^ NULL in SQL or Nothing in Haskell + deriving (Show) + +instance Eq SqlValue where + SqlString a == SqlString b = a == b + SqlByteString a == SqlByteString b = a == b + SqlWord32 a == SqlWord32 b = a == b + SqlWord64 a == SqlWord64 b = a == b + SqlInt32 a == SqlInt32 b = a == b + SqlInt64 a == SqlInt64 b = a == b + SqlInteger a == SqlInteger b = a == b + SqlChar a == SqlChar b = a == b + SqlBool a == SqlBool b = a == b + SqlDouble a == SqlDouble b = a == b + SqlRational a == SqlRational b = a == b + SqlEpochTime a == SqlEpochTime b = a == b + SqlTimeDiff a == SqlTimeDiff b = a == b + SqlNull == SqlNull = True + SqlNull == _ = False + _ == SqlNull = False + a == b = ((fromSql a)::String) == ((fromSql b)::String) + +instance SqlType String where + toSql = SqlString + fromSql (SqlString x) = x + fromSql (SqlByteString x) = byteString2String x + fromSql (SqlInt32 x) = show x + fromSql (SqlInt64 x) = show x + fromSql (SqlWord32 x) = show x + fromSql (SqlWord64 x) = show x + fromSql (SqlInteger x) = show x + fromSql (SqlChar x) = [x] + fromSql (SqlBool x) = show x + fromSql (SqlDouble x) = show x + fromSql (SqlRational x) = show x + fromSql (SqlEpochTime x) = show x + fromSql (SqlTimeDiff x) = show x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to String" + +instance SqlType B.ByteString where + toSql = SqlByteString + fromSql (SqlByteString x) = x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to ByteString" + fromSql x = (string2ByteString . fromSql) x + +string2ByteString :: String -> B.ByteString +string2ByteString = B.pack . map (toEnum . fromEnum) + +instance SqlType Int where + toSql x = SqlInt32 (fromIntegral x) + fromSql (SqlString x) = read' x + fromSql (SqlByteString x) = (read' . byteString2String) x + fromSql (SqlInt32 x) = fromIntegral x + fromSql (SqlInt64 x) = fromIntegral x + fromSql (SqlWord32 x) = fromIntegral x + fromSql (SqlWord64 x) = fromIntegral x + fromSql (SqlInteger x) = fromIntegral x + fromSql (SqlChar x) = ord x + fromSql (SqlBool x) = if x then 1 else 0 + fromSql (SqlDouble x) = truncate $ x + fromSql (SqlRational x) = truncate $ x + fromSql (SqlEpochTime x) = fromIntegral x + fromSql (SqlTimeDiff x) = fromIntegral x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Int" + +instance SqlType Int32 where + toSql = SqlInt32 + fromSql (SqlString x) = read' x + fromSql (SqlByteString x) = (read' . byteString2String) x + fromSql (SqlInt32 x) = x + fromSql (SqlInt64 x) = fromIntegral x + fromSql (SqlWord32 x) = fromIntegral x + fromSql (SqlWord64 x) = fromIntegral x + fromSql (SqlInteger x) = fromIntegral x + fromSql (SqlChar x) = fromIntegral $ ord x + fromSql (SqlBool x) = if x then 1 else 0 + fromSql (SqlDouble x) = truncate $ x + fromSql (SqlRational x) = truncate $ x + fromSql (SqlEpochTime x) = fromIntegral x + fromSql (SqlTimeDiff x) = fromIntegral x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Int32" + +instance SqlType Int64 where + toSql = SqlInt64 + fromSql (SqlString x) = read' x + fromSql (SqlByteString x) = (read' . byteString2String) x + fromSql (SqlInt32 x) = fromIntegral x + fromSql (SqlInt64 x) = x + fromSql (SqlWord32 x) = fromIntegral x + fromSql (SqlWord64 x) = fromIntegral x + fromSql (SqlInteger x) = fromIntegral x + fromSql (SqlChar x) = fromIntegral $ ord x + fromSql (SqlBool x) = if x then 1 else 0 + fromSql (SqlDouble x) = truncate $ x + fromSql (SqlRational x) = truncate $ x + fromSql (SqlEpochTime x) = fromIntegral x + fromSql (SqlTimeDiff x) = fromIntegral x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Int64" + +instance SqlType Word32 where + toSql = SqlWord32 + fromSql (SqlString x) = read' x + fromSql (SqlByteString x) = (read' . byteString2String) x + fromSql (SqlInt32 x) = fromIntegral x + fromSql (SqlInt64 x) = fromIntegral x + fromSql (SqlWord32 x) = x + fromSql (SqlWord64 x) = fromIntegral x + fromSql (SqlInteger x) = fromIntegral x + fromSql (SqlChar x) = fromIntegral $ ord x + fromSql (SqlBool x) = if x then 1 else 0 + fromSql (SqlDouble x) = truncate $ x + fromSql (SqlRational x) = truncate $ x + fromSql (SqlEpochTime x) = fromIntegral x + fromSql (SqlTimeDiff x) = fromIntegral x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Word32" + +instance SqlType Word64 where + toSql = SqlWord64 + fromSql (SqlString x) = read' x + fromSql (SqlByteString x) = (read' . byteString2String) x + fromSql (SqlInt32 x) = fromIntegral x + fromSql (SqlInt64 x) = fromIntegral x + fromSql (SqlWord32 x) = fromIntegral x + fromSql (SqlWord64 x) = x + fromSql (SqlInteger x) = fromIntegral x + fromSql (SqlChar x) = fromIntegral (ord x) + fromSql (SqlBool x) = if x then 1 else 0 + fromSql (SqlDouble x) = truncate $ x + fromSql (SqlRational x) = truncate $ x + fromSql (SqlEpochTime x) = fromIntegral x + fromSql (SqlTimeDiff x) = fromIntegral x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Int64" + +instance SqlType Integer where + toSql = SqlInteger + fromSql (SqlString x) = read' x + fromSql (SqlByteString x) = (read' . byteString2String) x + fromSql (SqlInt32 x) = fromIntegral x + fromSql (SqlInt64 x) = fromIntegral x + fromSql (SqlWord32 x) = fromIntegral x + fromSql (SqlWord64 x) = fromIntegral x + fromSql (SqlInteger x) = x + fromSql (SqlChar x) = fromIntegral (ord x) + fromSql (SqlBool x) = if x then 1 else 0 + fromSql (SqlDouble x) = truncate $ x + fromSql (SqlRational x) = truncate $ x + fromSql (SqlEpochTime x) = x + fromSql (SqlTimeDiff x) = x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Integer" + +instance SqlType Bool where + toSql = SqlBool + fromSql (SqlString x) = + case map toUpper x of + "TRUE" -> True + "T" -> True + "FALSE" -> False + "F" -> False + _ -> error $ "fromSql: cannot convert SqlString " + ++ show x ++ " to Bool" + fromSql (SqlByteString x) = (fromSql . SqlString . byteString2String) x + fromSql (SqlInt32 x) = numToBool x + fromSql (SqlInt64 x) = numToBool x + fromSql (SqlWord32 x) = numToBool x + fromSql (SqlWord64 x) = numToBool x + fromSql (SqlInteger x) = numToBool x + fromSql (SqlChar x) = numToBool (ord x) + fromSql (SqlBool x) = x + fromSql (SqlDouble x) = numToBool x + fromSql (SqlRational x) = numToBool x + fromSql (SqlEpochTime x) = numToBool x + fromSql (SqlTimeDiff x) = numToBool x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Bool" + +numToBool :: Num a => a -> Bool +numToBool x = x /= 0 + +instance SqlType Char where + toSql = SqlChar + fromSql (SqlString [x]) = x + fromSql (SqlByteString x) = (head . byteString2String) x + fromSql (SqlString _) = error "fromSql: cannot convert SqlString to Char" + fromSql (SqlInt32 _) = error "fromSql: cannot convert SqlInt32 to Char" + fromSql (SqlInt64 _) = error "fromSql: cannot convert SqlInt64 to Char" + fromSql (SqlWord32 _) = error "fromSql: cannot convert SqlWord32 to Char" + fromSql (SqlWord64 _) = error "fromSql: cannot convert SqlWord64 to Char" + fromSql (SqlInteger _) = error "fromSql: cannot convert SqlInt to Char" + fromSql (SqlChar x) = x + fromSql (SqlBool x) = if x then '1' else '0' + fromSql (SqlDouble _) = error "fromSql: cannot convert SqlDouble to Char" + fromSql (SqlRational _) = error "fromSql: cannot convert SqlRational to Char" + fromSql (SqlEpochTime _) = error "fromSql: cannot convert SqlEpochTime to Char" + fromSql (SqlTimeDiff _) = error "fromSql: cannot convert SqlTimeDiff to Char" + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Char" + +instance SqlType Double where + toSql = SqlDouble + fromSql (SqlString x) = read' x + fromSql (SqlByteString x) = (read' . byteString2String) x + fromSql (SqlInt32 x) = fromIntegral x + fromSql (SqlInt64 x) = fromIntegral x + fromSql (SqlWord32 x) = fromIntegral x + fromSql (SqlWord64 x) = fromIntegral x + fromSql (SqlInteger x) = fromIntegral x + fromSql (SqlChar x) = fromIntegral . ord $ x + fromSql (SqlBool x) = if x then 1.0 else 0.0 + fromSql (SqlDouble x) = x + fromSql (SqlRational x) = fromRational x + fromSql (SqlEpochTime x) = fromIntegral x + fromSql (SqlTimeDiff x) = fromIntegral x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Double" + +instance SqlType Rational where + toSql = SqlRational + fromSql (SqlString x) = read' x + fromSql (SqlByteString x) = (read' . byteString2String) x + fromSql (SqlInt32 x) = fromIntegral x + fromSql (SqlInt64 x) = fromIntegral x + fromSql (SqlWord32 x) = fromIntegral x + fromSql (SqlWord64 x) = fromIntegral x + fromSql (SqlInteger x) = fromIntegral x + fromSql (SqlChar x) = fromIntegral . ord $ x + fromSql (SqlBool x) = fromIntegral $ ((fromSql (SqlBool x))::Int) + fromSql (SqlDouble x) = toRational x + fromSql (SqlRational x) = x + fromSql (SqlEpochTime x) = fromIntegral x + fromSql (SqlTimeDiff x) = fromIntegral x + fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Double" + +instance SqlType ClockTime where + toSql (TOD x _) = SqlEpochTime x + fromSql (SqlString x) = TOD (read' x) 0 + fromSql (SqlByteString x) = TOD ((read' . byteString2String) x) 0 + fromSql (SqlInt32 x) = TOD (fromIntegral x) 0 + fromSql (SqlInt64 x) = TOD (fromIntegral x) 0 + fromSql (SqlWord32 x) = TOD (fromIntegral x) 0 + fromSql (SqlWord64 x) = TOD (fromIntegral x) 0 + fromSql (SqlInteger x) = TOD x 0 + fromSql (SqlChar _) = error "fromSql: cannot convert SqlChar to ClockTime" + fromSql (SqlBool _) = error "fromSql: cannot convert SqlBool to ClockTime" + fromSql (SqlDouble x) = TOD (truncate x) 0 + fromSql (SqlRational x) = TOD (truncate x) 0 + fromSql (SqlEpochTime x) = TOD x 0 + fromSql (SqlTimeDiff _) = error "fromSql: cannot convert SqlTimeDiff to ClockTime" + fromSql SqlNull = error "fromSql: cannot convert SqlNull to ClockTime" + +instance SqlType TimeDiff where + toSql x = SqlTimeDiff (timeDiffToSecs x) + fromSql (SqlString x) = secs2td (read' x) + fromSql (SqlByteString x) = secs2td ((read' . byteString2String) x) + fromSql (SqlInt32 x) = secs2td (fromIntegral x) + fromSql (SqlInt64 x) = secs2td (fromIntegral x) + fromSql (SqlWord32 x) = secs2td (fromIntegral x) + fromSql (SqlWord64 x) = secs2td (fromIntegral x) + fromSql (SqlInteger x) = secs2td x + fromSql (SqlChar _) = error "fromSql: cannot convert SqlChar to TimeDiff" + fromSql (SqlBool _) = error "fromSql: cannot convert SqlBool to TimeDiff" + fromSql (SqlDouble x) = secs2td (truncate x) + fromSql (SqlRational x) = secs2td (truncate x) + fromSql (SqlEpochTime _) = error "fromSql: cannot convert SqlEpochTime to TimeDiff" + fromSql (SqlTimeDiff x) = secs2td x + fromSql SqlNull = error "fromSql: cannot convert SqlNull to TimeDiff" + +instance SqlType CalendarTime where + toSql x = toSql (toClockTime x) + fromSql = toUTCTime . fromSql + +instance (SqlType a) => SqlType (Maybe a) where + toSql Nothing = SqlNull + toSql (Just a) = toSql a + fromSql SqlNull = Nothing + fromSql x = Just (fromSql x) + +byteString2String :: B.ByteString -> String +byteString2String = map (toEnum . fromEnum) . B.unpack + +secs2td :: Integer -> TimeDiff +secs2td x = diffClockTimes (TOD x 0) (TOD 0 0) + + +-- | Read a value from a string, and give an informative message +-- if it fails. +read' :: (Typeable a,Read a) => String -> a +read' s = ret + where ret = case reads s of + [(x,"")] -> x + _ -> error $ "fromSql: Cannot read " ++ show s + ++ " as " ++ t ++ "." + t = show (typeOf ret) + +-------------- +-- The following function copied from MissingH.Time.hs + +{- | Converts the given timeDiff to the number of seconds it represents. + +Uses the same algorithm as normalizeTimeDiff in GHC. -} +timeDiffToSecs :: TimeDiff -> Integer +timeDiffToSecs td = + (fromIntegral $ tdSec td) + + 60 * ((fromIntegral $ tdMin td) + + 60 * ((fromIntegral $ tdHour td) + + 24 * ((fromIntegral $ tdDay td) + + 30 * ((fromIntegral $ tdMonth td) + + 365 * (fromIntegral $ tdYear td))))) diff --git a/Database/HDBC/Types.hs b/Database/HDBC/Types.hs --- a/Database/HDBC/Types.hs +++ b/Database/HDBC/Types.hs @@ -1,5 +1,5 @@ {- -Copyright (C) 2005 John Goerzen +Copyright (C) 2005-2007 John Goerzen This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public @@ -18,7 +18,7 @@ {- | Module : Database.HDBC.Types - Copyright : Copyright (C) 2005 John Goerzen + Copyright : Copyright (C) 2005-2007 John Goerzen License : GNU LGPL, version 2.1 or above Maintainer : John Goerzen @@ -35,25 +35,22 @@ -} module Database.HDBC.Types - (Connection(..), - Statement(..), - SqlError(..), - SqlType(..), nToSql, iToSql, - SqlValue(..) - + (IConnection(..), + Statement(..), + SqlError(..), + SqlType(..), nToSql, iToSql, + SqlValue(..), + ConnWrapper, + withWConn ) where -import Data.Dynamic -import Data.Char(ord,toUpper) -import Data.Word -import Data.Int -import System.Time +import Database.HDBC.Statement import Database.HDBC.ColTypes {- | Main database handle object. -A 'Connection' object is created by specific functions in the module for an +An 'IConnection' object is created by specific functions in the module for an individual database. That is, the connect function -- which creates this object -- is not standardized through the HDBC interface. @@ -63,11 +60,10 @@ to the database. In other words, HDBC has /no support for autocommit/, which we consider an outdated notion. -} -data Connection = - Connection { +class IConnection conn where {- | Disconnect from the remote database. -You do not need to explicitly close a Connection object, but you may do so if +You do not need to explicitly close an IConnection object, but you may do so if you so desire. If you don't, the object will disconnect from the database in a sane way when it is garbage-collected. However, a disconnection may raise an error, so you are encouraged to explicitly call 'disconnect'. Also, @@ -86,19 +82,19 @@ and vary by database. So don't do it. -} - disconnect :: IO (), + disconnect :: conn -> IO () {- | Commit any pending data to the database. Required to make any changes take effect. -} - commit :: IO (), + commit :: conn -> IO () {- | Roll back to the state the database was in prior to the last 'commit' or 'rollback'. -} - rollback :: IO (), + rollback :: conn -> IO () {- | Execute a single SQL query. Returns the number of rows modified (see 'execute' for details). The second parameter is a list of replacement values, if any. -} - run :: String -> [SqlValue] -> IO Integer, + run :: conn -> String -> [SqlValue] -> IO Integer {- | Prepares a statement for execution. Question marks in the statement will be replaced by @@ -108,7 +104,7 @@ and the driver, errors in your SQL may be raised either here or by 'execute'. Make sure you handle exceptions both places if necessary. -} - prepare :: String -> IO Statement, + prepare :: conn -> String -> IO Statement {- | Create a new 'Connection' object, pointed at the same server as this object is. This will generally establish a separate physical connection. @@ -125,7 +121,7 @@ This can also be a handy utility function whenever you need a separate connection to whatever database you are connected to already. -} - clone :: IO Connection, + clone :: conn -> IO conn {- | The name of the HDBC driver module for this connection. @@ -133,25 +129,25 @@ of the Cabal package name. For instance, \"sqlite3\" or \"odbc\". This is the layer that is bound most tightly to HDBC. -} - hdbcDriverName :: String, + hdbcDriverName :: conn -> String {- | The version of the C (or whatever) client library that the HDBC driver module is bound to. The meaning of this is driver-specific. For an ODBC or similar proxying driver, this should be the version of the ODBC library, not the eventual DB client driver. -} - hdbcClientVer :: String, + hdbcClientVer :: conn -> String {- | In the case of a system such as ODBC, the name of the database client\/server in use, if available. For others, identical to 'hdbcDriverName'. -} - proxiedClientName :: String, + proxiedClientName :: conn -> String {- | In the case of a system such as ODBC, the version of the database client in use, if available. For others, identical to 'hdbcClientVer'. This is the next layer out past the HDBC driver. -} - proxiedClientVer :: String, + proxiedClientVer :: conn -> String {- | The version of the database server, if available. -} - dbServerVer :: String, + dbServerVer :: conn -> String {- | Whether or not the current database supports transactions. If False, then 'commit' and 'rollback' should be expected to raise errors. @@ -159,466 +155,67 @@ MySQL is the only commonly-used database that is known to not support transactions entirely. Please see the MySQL notes in the ODBC driver for more information. -} - dbTransactionSupport :: Bool, + dbTransactionSupport :: conn -> Bool {- | The names of all tables accessible by the current connection, excluding special meta-tables (system tables). You should expect this to be returned in the same manner - as a result from 'Database.HDBC.fetchAllRows'. + as a result from 'Database.HDBC.fetchAllRows''. All results should be converted to lowercase for you before you see them. -} - getTables :: IO [String], + getTables :: conn -> IO [String] {- | Obtain information about the columns in a specific table. The String in the result set is the column name. You should expect this to be returned in the same manner - as a result from 'Database.HDBC.fetchAllRows'. + as a result from 'Database.HDBC.fetchAllRows''. All results should be converted to lowercase for you before you see them. -} - describeTable :: String -> IO [(String, SqlColDesc)] - - } - -data Statement = Statement - { - {- | Execute the prepared statement, passing in the given positional - parameters (that should take the place of the question marks - in the call to 'prepare'). - - For non-SELECT queries, the return value is the number of - rows modified, if known. If no rows were modified, you get 0. - If the value is unknown, you get -1. All current HDBC drivers - support this function and should never return -1. - - For SELECT queries, you will always get 0. - - This function should automatically call finish() to finish the previous - execution, if necessary. - -} - execute :: [SqlValue] -> IO Integer, - - {- | Execute the query with many rows. - The return value is the return value from the final row - as if you had called 'execute' on it. - - Due to optimizations that are possible due to different - databases and driver designs, this can often be significantly - faster than using 'execute' multiple times since queries - need to be compiled only once. - - This is most useful for non-SELECT statements. -} - executeMany :: [[SqlValue]] -> IO (), - - {- | Abort a query in progress -- usually not needed. -} - finish :: IO (), - - {- | Fetches one row from the DB. Returns 'Nothing' if there - are no more rows. Will automatically call 'finish' when - the last row is read. -} - fetchRow :: IO (Maybe [SqlValue]), - - {- | Returns a list of the column names in the result. - For maximum portability, you should not assume that - information is available until after an 'execute' function - has been run. - - Information is returned here directly as returned - by the underlying database layer. Note that different - databases have different rules about capitalization - of return values and about representation of names - of columns that are not simple columns. For this reason, - it is suggested that you treat this information for - display purposes only. Failing that, you should convert - to lower (or upper) case, and use @AS@ clauses for - anything other than simple columns. - - A simple getColumnNames implementation could simply - apply @map fst@ to the return value of 'describeResult'. - -} - getColumnNames :: IO [String], - - - {- | The original query that this 'Statement' was prepared - with. -} - originalQuery :: String, - {- | Obtain information about the columns in the result set. - Must be run only after 'execute'. The String in the result - set is the column name. - - You should expect this to be returned in the same manner - as a result from 'Database.HDBC.fetchAllRows'. + describeTable :: conn -> String -> IO [(String, SqlColDesc)] - All results should be converted to lowercase for you - before you see them. +{- | Sometimes, it is annoying to use typeclasses with Haskell's type system. +In those situations, you can use a ConnWrapper. You can create one with: - Please see caveats under 'getColumnNames' for information - on the column name field here. - -} - describeResult :: IO [(String, SqlColDesc)] - } +>let wrapped = ConnWrapper iconn -{- | The main HDBC exception object. As much information as possible -is passed from the database through to the application through this object. +You can then use this directly, since a ConnWrapper is also an +'IConnection'. However, you will not be able to use private database +functions on it. -Errors generated in the Haskell layer will have seNativeError set to -1. +Or, you can use 'withWConn'. -} -data SqlError = SqlError {seState :: String, - seNativeError :: Int, - seErrorMsg :: String} - deriving (Eq, Show, Read) - -sqlErrorTc :: TyCon -sqlErrorTc = mkTyCon "Database.HDBC.SqlError" - -instance Typeable SqlError where - typeOf _ = mkTyConApp sqlErrorTc [] - -{- | Conversions to and from 'SqlValue's and standard Haskell types. - -Conversions are powerful; for instance, you can call 'fromSql' on a SqlInt32 -and get a String or a Double out of it. This class attempts to Do -The Right Thing whenever possible, and will raise an error when asked to -do something incorrect. In particular, when converting to any type -except a Maybe, 'SqlNull' as the input will cause an error to be raised. - -Here are some notes about conversion: +data ConnWrapper = forall conn. IConnection conn => ConnWrapper conn - * Fractions of a second are not preserved on time values +{- | Unwrap a 'ConnWrapper' and pass the embedded 'IConnection' to +a function. Example: -See also 'nToSql', 'iToSql'. +>withWConn wrapped run $ "SELECT * from foo where bar = 1" [] -} - -class (Show a) => SqlType a where - toSql :: a -> SqlValue - fromSql :: SqlValue -> a - -{- | Converts any Integral type to a 'SqlValue' by using toInteger. -} -nToSql :: Integral a => a -> SqlValue -nToSql n = SqlInteger (toInteger n) - -{- | Convenience function for using numeric literals in your program. -} -iToSql :: Int -> SqlValue -iToSql = toSql - -{- | The main type for expressing Haskell values to SQL databases. - -This type is used to marshall Haskell data to and from database APIs. -HDBC driver interfaces will do their best to use the most accurate and -efficient way to send a particular value to the database server. - -Values read back from the server are put in the most appropriate 'SqlValue' -type. 'fromSql' can then be used to convert them into whatever type -is needed locally in Haskell. - -Most people will use 'toSql' and 'fromSql' instead of manipulating -'SqlValue's directly. - -The default representation of time values is an integer number of seconds. -Databases such as PostgreSQL with builtin timestamp types can will see -automatic conversion between these Haskell types to local types. Other -databases can just use an int or a string. - -This behavior also exists for other types. For instance, many databases don't -have a Rational type, so they'll just use Haskell's show function and -store a Rational as a string. - -Two SqlValues are considered to be equal if one of these hold (first one that -is true holds; if none are true, they are not equal): - * Both are NULL - * Both represent the same type and the encapsulated values are equal - * The values of each, when converted to a string, are equal. -} -data SqlValue = SqlString String - | SqlWord32 Word32 - | SqlWord64 Word64 - | SqlInt32 Int32 - | SqlInt64 Int64 - | SqlInteger Integer - | SqlChar Char - | SqlBool Bool - | SqlDouble Double - | SqlRational Rational - | SqlEpochTime Integer -- ^ Representation of ClockTime or CalendarTime - | SqlTimeDiff Integer -- ^ Representation of TimeDiff - | SqlNull -- ^ NULL in SQL or Nothing in Haskell - deriving (Show) - -instance Eq SqlValue where - SqlString a == SqlString b = a == b - SqlWord32 a == SqlWord32 b = a == b - SqlWord64 a == SqlWord64 b = a == b - SqlInt32 a == SqlInt32 b = a == b - SqlInt64 a == SqlInt64 b = a == b - SqlInteger a == SqlInteger b = a == b - SqlChar a == SqlChar b = a == b - SqlBool a == SqlBool b = a == b - SqlDouble a == SqlDouble b = a == b - SqlRational a == SqlRational b = a == b - SqlEpochTime a == SqlEpochTime b = a == b - SqlTimeDiff a == SqlTimeDiff b = a == b - SqlNull == SqlNull = True - a == b = ((fromSql a)::String) == ((fromSql b)::String) - -instance SqlType String where - toSql = SqlString - fromSql (SqlString x) = x - fromSql (SqlInt32 x) = show x - fromSql (SqlInt64 x) = show x - fromSql (SqlWord32 x) = show x - fromSql (SqlWord64 x) = show x - fromSql (SqlInteger x) = show x - fromSql (SqlChar x) = [x] - fromSql (SqlBool x) = show x - fromSql (SqlDouble x) = show x - fromSql (SqlRational x) = show x - fromSql (SqlEpochTime x) = show x - fromSql (SqlTimeDiff x) = show x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to String" - -instance SqlType Int where - toSql x = SqlInt32 (fromIntegral x) - fromSql (SqlString x) = read' x - fromSql (SqlInt32 x) = fromIntegral x - fromSql (SqlInt64 x) = fromIntegral x - fromSql (SqlWord32 x) = fromIntegral x - fromSql (SqlWord64 x) = fromIntegral x - fromSql (SqlInteger x) = fromIntegral x - fromSql (SqlChar x) = ord x - fromSql (SqlBool x) = if x then 1 else 0 - fromSql (SqlDouble x) = truncate $ x - fromSql (SqlRational x) = truncate $ x - fromSql (SqlEpochTime x) = fromIntegral x - fromSql (SqlTimeDiff x) = fromIntegral x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Int" - -instance SqlType Int32 where - toSql = SqlInt32 - fromSql (SqlString x) = read' x - fromSql (SqlInt32 x) = x - fromSql (SqlInt64 x) = fromIntegral x - fromSql (SqlWord32 x) = fromIntegral x - fromSql (SqlWord64 x) = fromIntegral x - fromSql (SqlInteger x) = fromIntegral x - fromSql (SqlChar x) = fromIntegral $ ord x - fromSql (SqlBool x) = if x then 1 else 0 - fromSql (SqlDouble x) = truncate $ x - fromSql (SqlRational x) = truncate $ x - fromSql (SqlEpochTime x) = fromIntegral x - fromSql (SqlTimeDiff x) = fromIntegral x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Int32" - -instance SqlType Int64 where - toSql = SqlInt64 - fromSql (SqlString x) = read' x - fromSql (SqlInt32 x) = fromIntegral x - fromSql (SqlInt64 x) = x - fromSql (SqlWord32 x) = fromIntegral x - fromSql (SqlWord64 x) = fromIntegral x - fromSql (SqlInteger x) = fromIntegral x - fromSql (SqlChar x) = fromIntegral $ ord x - fromSql (SqlBool x) = if x then 1 else 0 - fromSql (SqlDouble x) = truncate $ x - fromSql (SqlRational x) = truncate $ x - fromSql (SqlEpochTime x) = fromIntegral x - fromSql (SqlTimeDiff x) = fromIntegral x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Int64" - -instance SqlType Word32 where - toSql = SqlWord32 - fromSql (SqlString x) = read' x - fromSql (SqlInt32 x) = fromIntegral x - fromSql (SqlInt64 x) = fromIntegral x - fromSql (SqlWord32 x) = x - fromSql (SqlWord64 x) = fromIntegral x - fromSql (SqlInteger x) = fromIntegral x - fromSql (SqlChar x) = fromIntegral $ ord x - fromSql (SqlBool x) = if x then 1 else 0 - fromSql (SqlDouble x) = truncate $ x - fromSql (SqlRational x) = truncate $ x - fromSql (SqlEpochTime x) = fromIntegral x - fromSql (SqlTimeDiff x) = fromIntegral x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Word32" - -instance SqlType Word64 where - toSql = SqlWord64 - fromSql (SqlString x) = read' x - fromSql (SqlInt32 x) = fromIntegral x - fromSql (SqlInt64 x) = fromIntegral x - fromSql (SqlWord32 x) = fromIntegral x - fromSql (SqlWord64 x) = x - fromSql (SqlInteger x) = fromIntegral x - fromSql (SqlChar x) = fromIntegral (ord x) - fromSql (SqlBool x) = if x then 1 else 0 - fromSql (SqlDouble x) = truncate $ x - fromSql (SqlRational x) = truncate $ x - fromSql (SqlEpochTime x) = fromIntegral x - fromSql (SqlTimeDiff x) = fromIntegral x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Int64" - -instance SqlType Integer where - toSql = SqlInteger - fromSql (SqlString x) = read' x - fromSql (SqlInt32 x) = fromIntegral x - fromSql (SqlInt64 x) = fromIntegral x - fromSql (SqlWord32 x) = fromIntegral x - fromSql (SqlWord64 x) = fromIntegral x - fromSql (SqlInteger x) = x - fromSql (SqlChar x) = fromIntegral (ord x) - fromSql (SqlBool x) = if x then 1 else 0 - fromSql (SqlDouble x) = truncate $ x - fromSql (SqlRational x) = truncate $ x - fromSql (SqlEpochTime x) = x - fromSql (SqlTimeDiff x) = x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Integer" - -instance SqlType Bool where - toSql = SqlBool - fromSql (SqlString x) = - case map toUpper x of - "TRUE" -> True - "T" -> True - "FALSE" -> False - "F" -> False - _ -> error $ "fromSql: cannot convert SqlString " - ++ show x ++ " to Bool" - fromSql (SqlInt32 x) = numToBool x - fromSql (SqlInt64 x) = numToBool x - fromSql (SqlWord32 x) = numToBool x - fromSql (SqlWord64 x) = numToBool x - fromSql (SqlInteger x) = numToBool x - fromSql (SqlChar x) = numToBool (ord x) - fromSql (SqlBool x) = x - fromSql (SqlDouble x) = numToBool x - fromSql (SqlRational x) = numToBool x - fromSql (SqlEpochTime x) = numToBool x - fromSql (SqlTimeDiff x) = numToBool x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Bool" - -numToBool :: Num a => a -> Bool -numToBool x = x /= 0 - -instance SqlType Char where - toSql = SqlChar - fromSql (SqlString [x]) = x - fromSql (SqlString _) = error "fromSql: cannot convert SqlString to Char" - fromSql (SqlInt32 _) = error "fromSql: cannot convert SqlInt32 to Char" - fromSql (SqlInt64 _) = error "fromSql: cannot convert SqlInt64 to Char" - fromSql (SqlWord32 _) = error "fromSql: cannot convert SqlWord32 to Char" - fromSql (SqlWord64 _) = error "fromSql: cannot convert SqlWord64 to Char" - fromSql (SqlInteger _) = error "fromSql: cannot convert SqlInt to Char" - fromSql (SqlChar x) = x - fromSql (SqlBool x) = if x then '1' else '0' - fromSql (SqlDouble _) = error "fromSql: cannot convert SqlDouble to Char" - fromSql (SqlRational _) = error "fromSql: cannot convert SqlRational to Char" - fromSql (SqlEpochTime _) = error "fromSql: cannot convert SqlEpochTime to Char" - fromSql (SqlTimeDiff _) = error "fromSql: cannot convert SqlTimeDiff to Char" - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Char" - -instance SqlType Double where - toSql = SqlDouble - fromSql (SqlString x) = read' x - fromSql (SqlInt32 x) = fromIntegral x - fromSql (SqlInt64 x) = fromIntegral x - fromSql (SqlWord32 x) = fromIntegral x - fromSql (SqlWord64 x) = fromIntegral x - fromSql (SqlInteger x) = fromIntegral x - fromSql (SqlChar x) = fromIntegral . ord $ x - fromSql (SqlBool x) = if x then 1.0 else 0.0 - fromSql (SqlDouble x) = x - fromSql (SqlRational x) = fromRational x - fromSql (SqlEpochTime x) = fromIntegral x - fromSql (SqlTimeDiff x) = fromIntegral x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Double" - -instance SqlType Rational where - toSql = SqlRational - fromSql (SqlString x) = read' x - fromSql (SqlInt32 x) = fromIntegral x - fromSql (SqlInt64 x) = fromIntegral x - fromSql (SqlWord32 x) = fromIntegral x - fromSql (SqlWord64 x) = fromIntegral x - fromSql (SqlInteger x) = fromIntegral x - fromSql (SqlChar x) = fromIntegral . ord $ x - fromSql (SqlBool x) = fromIntegral $ ((fromSql (SqlBool x))::Int) - fromSql (SqlDouble x) = toRational x - fromSql (SqlRational x) = x - fromSql (SqlEpochTime x) = fromIntegral x - fromSql (SqlTimeDiff x) = fromIntegral x - fromSql (SqlNull) = error "fromSql: cannot convert SqlNull to Double" - -instance SqlType ClockTime where - toSql (TOD x _) = SqlEpochTime x - fromSql (SqlString x) = TOD (read' x) 0 - fromSql (SqlInt32 x) = TOD (fromIntegral x) 0 - fromSql (SqlInt64 x) = TOD (fromIntegral x) 0 - fromSql (SqlWord32 x) = TOD (fromIntegral x) 0 - fromSql (SqlWord64 x) = TOD (fromIntegral x) 0 - fromSql (SqlInteger x) = TOD x 0 - fromSql (SqlChar _) = error "fromSql: cannot convert SqlChar to ClockTime" - fromSql (SqlBool _) = error "fromSql: cannot convert SqlBool to ClockTime" - fromSql (SqlDouble x) = TOD (truncate x) 0 - fromSql (SqlRational x) = TOD (truncate x) 0 - fromSql (SqlEpochTime x) = TOD x 0 - fromSql (SqlTimeDiff _) = error "fromSql: cannot convert SqlTimeDiff to ClockTime" - fromSql SqlNull = error "fromSql: cannot convert SqlNull to ClockTime" - -instance SqlType TimeDiff where - toSql x = SqlTimeDiff (timeDiffToSecs x) - fromSql (SqlString x) = secs2td (read' x) - fromSql (SqlInt32 x) = secs2td (fromIntegral x) - fromSql (SqlInt64 x) = secs2td (fromIntegral x) - fromSql (SqlWord32 x) = secs2td (fromIntegral x) - fromSql (SqlWord64 x) = secs2td (fromIntegral x) - fromSql (SqlInteger x) = secs2td x - fromSql (SqlChar _) = error "fromSql: cannot convert SqlChar to TimeDiff" - fromSql (SqlBool _) = error "fromSql: cannot convert SqlBool to TimeDiff" - fromSql (SqlDouble x) = secs2td (truncate x) - fromSql (SqlRational x) = secs2td (truncate x) - fromSql (SqlEpochTime _) = error "fromSql: cannot convert SqlEpochTime to TimeDiff" - fromSql (SqlTimeDiff x) = secs2td x - fromSql SqlNull = error "fromSql: cannot convert SqlNull to TimeDiff" - -instance SqlType CalendarTime where - toSql x = toSql (toClockTime x) - fromSql = toUTCTime . fromSql - -instance (SqlType a) => SqlType (Maybe a) where - toSql Nothing = SqlNull - toSql (Just a) = toSql a - fromSql SqlNull = Nothing - fromSql x = Just (fromSql x) - -secs2td :: Integer -> TimeDiff -secs2td x = diffClockTimes (TOD x 0) (TOD 0 0) - - --- | Read a value from a string, and give an informative message --- if it fails. -read' :: (Typeable a,Read a) => String -> a -read' s = ret - where ret = case reads s of - [(x,"")] -> x - _ -> error $ "fromSql: Cannot read " ++ show s - ++ " as " ++ t ++ "." - t = show (typeOf ret) - --------------- --- The following function copied from MissingH.Time.hs +withWConn :: forall b. ConnWrapper -> (forall conn. IConnection conn => conn -> b) -> b +withWConn conn f = + case conn of + ConnWrapper x -> f x -{- | Converts the given timeDiff to the number of seconds it represents. +instance IConnection ConnWrapper where + disconnect w = withWConn w disconnect + commit w = withWConn w commit + rollback w = withWConn w rollback + run w = withWConn w run + prepare w = withWConn w prepare + clone w = withWConn w (\dbh -> clone dbh >>= return . ConnWrapper) + hdbcDriverName w = withWConn w hdbcDriverName + hdbcClientVer w = withWConn w hdbcClientVer + proxiedClientName w = withWConn w proxiedClientName + proxiedClientVer w = withWConn w proxiedClientVer + dbServerVer w = withWConn w dbServerVer + dbTransactionSupport w = withWConn w dbTransactionSupport + getTables w = withWConn w getTables + describeTable w = withWConn w describeTable -Uses the same algorithm as normalizeTimeDiff in GHC. -} -timeDiffToSecs :: TimeDiff -> Integer -timeDiffToSecs td = - (fromIntegral $ tdSec td) + - 60 * ((fromIntegral $ tdMin td) + - 60 * ((fromIntegral $ tdHour td) + - 24 * ((fromIntegral $ tdDay td) + - 30 * ((fromIntegral $ tdMonth td) + - 365 * (fromIntegral $ tdYear td))))) diff --git a/Database/HDBC/Utils.hs b/Database/HDBC/Utils.hs --- a/Database/HDBC/Utils.hs +++ b/Database/HDBC/Utils.hs @@ -41,6 +41,7 @@ import Data.Char import Data.Dynamic import System.IO.Unsafe +import Data.List(genericLength) {- | Execute the given IO action. @@ -68,7 +69,7 @@ where handler e = fail ("SQL error: " ++ show e) {- | Like 'run', but take a list of Maybe Strings instead of 'SqlValue's. -} -sRun :: Connection -> String -> [Maybe String] -> IO Integer +sRun :: IConnection conn => conn -> String -> [Maybe String] -> IO Integer sRun conn qry lst = run conn qry (map toSql lst) @@ -98,7 +99,7 @@ This function, therefore, encapsulates the logical property that a transaction is all about: all or nothing. -The 'Connection' object passed in is passed directly to the specified +The 'IConnection' object passed in is passed directly to the specified function as a convenience. This function traps /all/ uncaught exceptions, not just SqlErrors. Therefore, @@ -116,7 +117,7 @@ like to know about the root cause for all of this anyway.) Feedback on this behavior is solicited. -} -withTransaction :: Connection -> (Connection -> IO a) -> IO a +withTransaction :: IConnection conn => conn -> (conn -> IO a) -> IO a withTransaction conn func = do r <- try (func conn) case r of @@ -144,6 +145,9 @@ But then, similar caveats apply with hGetContents. Bottom line: this is a very convenient abstraction; use it wisely. + +Use 'fetchAllRows'' if you need something that is strict, without +all these caveats. -} fetchAllRows :: Statement -> IO [[SqlValue]] fetchAllRows sth = unsafeInterleaveIO $ @@ -153,12 +157,33 @@ Just x -> do remainder <- fetchAllRows sth return (x : remainder) +evalAll :: [[a]] -> IO Integer +evalAll inp = + do r1 <- mapM (evaluate . genericLength) inp + evaluate (sum r1) + +{- | Strict version of 'fetchAllRows'. Does not have the side-effects +of 'fetchAllRows', but forces the entire result set to be buffered +in memory. -} +fetchAllRows' :: Statement -> IO [[SqlValue]] +fetchAllRows' sth = + do res <- fetchAllRows sth + evalAll res + return res + {- | Like 'fetchAllRows', but return Maybe Strings instead of 'SqlValue's. -} sFetchAllRows :: Statement -> IO [[Maybe String]] sFetchAllRows sth = do res <- fetchAllRows sth return $ map (map fromSql) res +{- | Strict version of 'sFetchAllRows'. -} +sFetchAllRows' :: Statement -> IO [[Maybe String]] +sFetchAllRows' sth = + do res <- sFetchAllRows sth + evalAll res + return res + {- | Like 'fetchRow', but instead of returning a list, return an association list from column name to value. @@ -175,6 +200,15 @@ let names = map (map toLower) names_raw return $ Just $ zip names r +{- | Strict version of 'fetchRowAL' -} +fetchRowAL' :: Statement -> IO (Maybe [(String, SqlValue)]) +fetchRowAL' sth = + do res <- fetchRowAL sth + case res of + Nothing -> return 0 + Just x -> evaluate ((genericLength x)::Integer) + return res + {- | Similar to 'fetchRowAL', but return a Map instead of an association list. -} fetchRowMap :: Statement -> IO (Maybe (Map.Map String SqlValue)) @@ -184,6 +218,15 @@ Nothing -> return Nothing Just x -> return $ Just $ Map.fromList x +{- | Strict version of 'fetchRowMap' -} +fetchRowMap' :: Statement -> IO (Maybe (Map.Map String SqlValue)) +fetchRowMap' sth = + do res <- fetchRowMap sth + case res of + Nothing -> return 0 + Just x -> evaluate ((genericLength (Map.toList x))::Integer) + return res + {- | Like 'fetchAllRows', but instead of returning a list for each row, return an association list for each row, from column name to value. @@ -195,15 +238,37 @@ rows <- fetchAllRows sth return $ map (zip names) rows +{- | Strict version of 'fetchAllRowsAL' -} +fetchAllRowsAL' :: Statement -> IO [[(String, SqlValue)]] +fetchAllRowsAL' sth = + do res <- fetchAllRowsAL sth + evalAll res + return res + {- | Like 'fetchAllRowsAL', but return a list of Maps instead of a list of association lists. -} fetchAllRowsMap :: Statement -> IO [Map.Map String SqlValue] fetchAllRowsMap sth = fetchAllRowsAL sth >>= (return . map Map.fromList) +{- | Strict version of 'fetchAllRowsMap' -} +fetchAllRowsMap' :: Statement -> IO [Map.Map String SqlValue] +fetchAllRowsMap' sth = + do res <- fetchAllRowsMap sth + evaluate ((genericLength res)::Integer) + return res + {- | A quick way to do a query. Similar to preparing, executing, and -then calling 'fetchAllRows' on a statement. -} -quickQuery :: Connection -> String -> [SqlValue] -> IO [[SqlValue]] +then calling 'fetchAllRows' on a statement. See also 'quickQuery'' -} +quickQuery :: IConnection conn => conn -> String -> [SqlValue] -> IO [[SqlValue]] quickQuery conn qrystr args = do sth <- prepare conn qrystr execute sth args fetchAllRows sth + +{- | Strict version of 'quickQuery'. -} +quickQuery' :: IConnection conn => conn -> String -> [SqlValue] -> IO [[SqlValue]] +quickQuery' conn qrystr args = + do res <- quickQuery conn qrystr args + evalAll res + return res + diff --git a/HDBC.cabal b/HDBC.cabal --- a/HDBC.cabal +++ b/HDBC.cabal @@ -1,11 +1,21 @@ Name: HDBC -Version: 1.0.1 +Version: 1.1.3 License: LGPL Maintainer: John Goerzen -Stability: Alpha -Copyright: Copyright (c) 2005-2006 John Goerzen +Author: John Goerzen +Copyright: Copyright (c) 2005-2007 John Goerzen +license-file: COPYRIGHT +extra-source-files: COPYING +homepage: http://software.complete.org/hdbc +Category: Database +synopsis: Haskell Database Connectivity +Description: HDBC provides an abstraction layer between Haskell programs and SQL + relational databases. This lets you write database code once, in + Haskell, and have it work with any number of backend SQL databases + (MySQL, Oracle, PostgreSQL, ODBC-compliant databases, etc.) +Stability: Stable Exposed-Modules: Database.HDBC, Database.HDBC.Types, Database.HDBC.DriverUtils, - Database.HDBC.ColTypes + Database.HDBC.ColTypes, Database.HDBC.Statement Other-Modules: Database.HDBC.Utils --Extensions: ExistentialQuantification, AllowOverlappingInstances, -- AllowUndecidableInstances diff --git a/Makefile b/Makefile deleted file mode 100644 --- a/Makefile +++ /dev/null @@ -1,11 +0,0 @@ -all: - @echo "Please use Cabal to build this package; not make." - -.PHONY: doc -doc: - -rm -r doc - mkdir doc - haddock -h -t 'Haskell Database Connectivity (HDBC)' \ - -D doc/hdbc.interface \ - -o doc `find Database -name "*.hs"` - diff --git a/Memory.txt b/Memory.txt deleted file mode 100644 --- a/Memory.txt +++ /dev/null @@ -1,24 +0,0 @@ -Notes on memory management --------------------------- - -ForeignPtrs are used wherever possible to make sure we don't have -memory leaks. - -However, there is one potential problem with them. If a whole bunch -of database stuff goes out of scope all at once, then the Connection, -Statement, and everything else could become finalizable all at once. -And it is not guaranteed to be finalized in any particular order. - -We don't want to have the Connection finalized before the Statements. -This could cause segfaults with some databases. - -So we implement a simple reference counting system for the -Connection. Each use -- whether in a Connection or a Statement -- -counts as one, and the whole thing is freed when the use count drops -to 0 (the last object using it has been finalized). - -That solves almost every problem. We have one more: when somebody -calls disconnect on the parent, we really want to close all open -statements first. So a system of weak refs is used to handle that. -This makes sure that we free things in the proper order for explicit -disconnects as well. diff --git a/README.txt b/README.txt deleted file mode 100644 --- a/README.txt +++ /dev/null @@ -1,39 +0,0 @@ -Welcome to HDBC, Haskell Database Connectivity. - -HDBC is modeled loosely on Perl's DBI interface, though it has also -been influenced by Python's DB-API v2, JDBC in Java, and HSQL in -Haskell. - -Please see doc/Database-HDBC.html for an introduction to HDBC and its -various features. - -INSTALLATION ------------- - -You'll need either GHC 6.4.1 or above, or Hugs 2005xx or above. - -The steps to install are: - -1) ghc --make -o setup Setup.lhs - -2) ./setup configure - -3) ./setup build - -4) ./setup install (as root) - -If you're on Windows, you can omit the leading "./". - -Documentation is in doc/ -- lots of information, including pointers to -drivers, is in doc/Database-HDBC.html. - -USAGE ------ - -To use with hugs, you'll want to use hugs -98. - -To use with GHC, you'll want to use -package HDBC in your programs. -Or, with Cabal, use Build-Depends: HDBC. - --- John Goerzen - December 2005 diff --git a/Setup.lhs b/Setup.lhs --- a/Setup.lhs +++ b/Setup.lhs @@ -1,4 +1,4 @@ -#!/usr/bin/env runhugs +#!/usr/bin/env runhaskell > import Distribution.Simple diff --git a/debian/README.Debian b/debian/README.Debian deleted file mode 100644 --- a/debian/README.Debian +++ /dev/null @@ -1,15 +0,0 @@ -hdbc for Debian ---------------- - -To use HDBC in your programs, you'll need a driver package as well. - -apt-cache search hdbc will give you a convenient list of the HDBC drivers -available in Debian. - -To use HDBC in GHC, you'll need to use -package HDBC on your command line, -or, with Cabal, list a Build-Depends on HDBC. - -You can find documentation for the HDBC API under -/usr/share/doc/libhdbc-ghc6-dev or /usr/share/doc/libhdbc-hugs. - - -- John Goerzen , Tue Dec 27 10:40:56 2005 diff --git a/debian/changelog b/debian/changelog deleted file mode 100644 --- a/debian/changelog +++ /dev/null @@ -1,39 +0,0 @@ -hdbc (1.0.1) unstable; urgency=low - - * Now accept T and F for True and False from the underlying database - layer -- compatibility with PostgreSQL - - -- John Goerzen Sat, 22 Jul 2006 07:11:08 -0500 - -hdbc (1.0.0) unstable; urgency=low - - * Blessing this version as 1.0.0. Whee! - - -- John Goerzen Thu, 29 Jun 2006 18:23:03 -0500 - -hdbc (0.99.3) unstable; urgency=low - - * [bringert] Better error messages when fromSql encounters - data it doesn't understand - * Rebuilt for GHC 6.4.2 - - -- John Goerzen Wed, 28 Jun 2006 15:00:09 -0500 - -hdbc (0.99.2) unstable; urgency=low - - * New call dbTransactionSupport - - -- John Goerzen Tue, 28 Mar 2006 04:57:00 -0600 - -hdbc (0.99.1) unstable; urgency=low - - * Release 0.99.1. New features include generalized memory - management support and column metadata. - - -- John Goerzen Mon, 27 Mar 2006 18:54:24 -0600 - -hdbc (0.99.0) unstable; urgency=low - - * Initial Release. Closes: #344913. - - -- John Goerzen Tue, 27 Dec 2005 10:22:53 -0600 diff --git a/debian/compat b/debian/compat deleted file mode 100644 --- a/debian/compat +++ /dev/null @@ -1,1 +0,0 @@ -4 diff --git a/debian/control b/debian/control deleted file mode 100644 --- a/debian/control +++ /dev/null @@ -1,41 +0,0 @@ -Source: hdbc -Priority: optional -Maintainer: John Goerzen -Build-Depends: debhelper (>= 4.0.0), ghc6 (>= 6.4.2), ghc6 (<< 6.4.2-999), haskell-devscripts (>= 0.5.6), cpphs, haddock -Build-Depends-Indep: debhelper (>= 4.0.0), haddock, hugs (>= 98.200503.08), haskell-devscripts (>= 0.5.6), ghc6 (>= 6.4.2) -Standards-Version: 3.6.2 -Section: libs - -Package: libghc6-hdbc-dev -Section: libdevel -Architecture: any -Depends: ${haskell:Depends} -Suggests: libghc6-hdbc-postgresql-dev | libghc6-hdbc-sqlite3-dev, libghc6-hdbc-missingh-dev -Description: Haskell Database Connectivity, GHC6 package - HDBC provides an abstraction layer between Haskell programs and SQL - relational databases. This lets you write database code once, in - Haskell, and have it work with any number of backend SQL databases - (MySQL, Oracle, PostgreSQL, ODBC-compliant databases, etc.) - . - HDBC is modeled loosely on Perl's DBI interface, though it has also been - influenced by Python's DB-API v2, JDBC in Java, and HSQL in Haskell. - . - To use HDBC, you'll need both this package, and a driver package such - as libghc6-hdbc-postgresql-dev. - -Package: libhugs-hdbc -Section: libs -Architecture: all -Depends: ${haskell:Depends} -Description: Haskell Database Connectivity, Hugs package - HDBC provides an abstraction layer between Haskell programs and SQL - relational databases. This lets you write database code once, in - Haskell, and have it work with any number of backend SQL databases - (MySQL, Oracle, PostgreSQL, ODBC-compliant databases, etc.) - . - HDBC is modeled loosely on Perl's DBI interface, though it has also been - influenced by Python's DB-API v2, JDBC in Java, and HSQL in Haskell. - . - To use HDBC, you'll need both this package, and a driver package such - as libhugs-hdbc-postgresql. - diff --git a/debian/copyright b/debian/copyright deleted file mode 100644 --- a/debian/copyright +++ /dev/null @@ -1,27 +0,0 @@ -This is hdbc, written and maintained by John Goerzen -on Tue, 27 Dec 2005 10:22:53 -0600. - -The original source can always be found at: - ftp://ftp.debian.org/dists/unstable/main/source/ - -The Darcs repository for this program can be accessed with: - darcs get --partial http://darcs.complete.org/hdbc - -Copyright (C) 2005-2006 John Goerzen - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - -On Debian systems, the complete text of the GNU Lesser General -Public License can be found in `/usr/share/common-licenses/LGPL'. diff --git a/debian/hdbc.doc-base.EX b/debian/hdbc.doc-base.EX deleted file mode 100644 --- a/debian/hdbc.doc-base.EX +++ /dev/null @@ -1,22 +0,0 @@ -Document: hdbc -Title: Debian hdbc Manual -Author: -Abstract: This manual describes what hdbc is - and how it can be used to - manage online manuals on Debian systems. -Section: unknown - -Format: debiandoc-sgml -Files: /usr/share/doc/hdbc/hdbc.sgml.gz - -Format: postscript -Files: /usr/share/doc/hdbc/hdbc.ps.gz - -Format: text -Files: /usr/share/doc/hdbc/hdbc.text.gz - -Format: HTML -Index: /usr/share/doc/hdbc/html/index.html -Files: /usr/share/doc/hdbc/html/*.html - - diff --git a/debian/rules b/debian/rules deleted file mode 100644 --- a/debian/rules +++ /dev/null @@ -1,147 +0,0 @@ -#!/usr/bin/make -f -# -*- makefile -*- -# Sample debian/rules that uses debhelper. -# This file was originally written by Joey Hess and Craig Small. -# As a special exception, when this file is copied by dh-make into a -# dh-make output file, you may use that output file without restriction. -# This special exception was added by Craig Small in version 0.37 of dh-make. - -# Uncomment this to turn on verbose mode. -#export DH_VERBOSE=1 - - - - -CFLAGS = -Wall -g - -ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS))) - CFLAGS += -O0 -else - CFLAGS += -O2 -endif - -# shared library versions, option 1 -version=2.0.5 -major=2 -# option 2, assuming the library is created as src/.libs/libfoo.so.2.0.5 or so -#version=`ls src/.libs/lib*.so.* | \ -# awk '{if (match($$0,/[0-9]+\.[0-9]+\.[0-9]+$$/)) print substr($$0,RSTART)}'` -#major=`ls src/.libs/lib*.so.* | \ -# awk '{if (match($$0,/\.so\.[0-9]+$$/)) print substr($$0,RSTART+4)}'` - -configure: configure-stamp -configure-stamp: - dh_testdir - # Add here commands to configure the package. - - touch configure-stamp - - -build: build-stamp -build-stamp: configure-stamp - dh_testdir - - # Add here commands to compile the package. - #$(MAKE) - - touch build-stamp - -clean: - dh_testdir - dh_testroot - rm -f build-stamp configure-stamp - - # Add here commands to clean up after the build process. - #-$(MAKE) clean - -./setup clean - -rm -rf setup Setup.hi Setup.ho Setup.o .*config* dist - - dh_clean - -install-a: build - dh_testdir - dh_testroot - dh_clean -k - dh_installdirs - - # Add here commands to install the package into debian/tmp - #$(MAKE) install DESTDIR=$(CURDIR)/debian/tmp - dh_haskell -a - -install-i: build - dh_testdir - dh_testroot - dh_clean -k - dh_installdirs - - # Add here commands to install the package into debian/tmp - #$(MAKE) install DESTDIR=$(CURDIR)/debian/tmp - dh_haskell -i - - - - -# Build architecture-independent files here. -binary-indep: build install-i - dh_testdir - dh_testroot - dh_installchangelogs -i - dh_installdocs -i README.txt doc/* - dh_installexamples -i -# dh_install -# dh_installmenu -# dh_installdebconf -# dh_installlogrotate -# dh_installemacsen -# dh_installpam -# dh_installmime -# dh_installinit -# dh_installcron -# dh_installinfo - dh_installman -i - dh_link -i - dh_strip -i - dh_compress -i - dh_fixperms -i -# dh_perl -# dh_python -# dh_makeshlibs - dh_installdeb -i - dh_shlibdeps -i - dh_gencontrol -i - dh_md5sums -i - dh_builddeb -i - -# Build architecture-dependent files here. -binary-arch: build install-a - dh_testdir - dh_testroot - dh_installchangelogs -a - dh_installdocs -a README.txt doc/* - dh_installexamples -a -# dh_install -# dh_installmenu -# dh_installdebconf -# dh_installlogrotate -# dh_installemacsen -# dh_installpam -# dh_installmime -# dh_installinit -# dh_installcron -# dh_installinfo - dh_installman -a - dh_link -a - dh_strip -a - dh_compress -a - dh_fixperms -a -# dh_perl -# dh_python -# dh_makeshlibs - dh_installdeb -a - dh_shlibdeps -a - dh_gencontrol -a - dh_md5sums -a - dh_builddeb -a - -binary: binary-indep binary-arch -.PHONY: build clean binary-indep binary-arch binary install configure diff --git a/doc/Database-HDBC-ColTypes.html b/doc/Database-HDBC-ColTypes.html deleted file mode 100644 --- a/doc/Database-HDBC-ColTypes.html +++ /dev/null @@ -1,1232 +0,0 @@ - - -Database.HDBC.ColTypes
Haskell Database Connectivity (HDBC)ContentsIndex
Database.HDBC.ColTypes
Portabilityportable
Stabilityprovisional
MaintainerJohn Goerzen <jgoerzen@complete.org>
Description

Definitions of, and utilities for, specifying what type of data is represented -by a column. -

Written by John Goerzen, jgoerzen@complete.org -

Synopsis
data SqlColDesc = SqlColDesc {
colType :: SqlTypeId
colSize :: (Maybe Int)
colOctetLength :: (Maybe Int)
colDecDigits :: (Maybe Int)
colNullable :: (Maybe Bool)
}
data SqlTypeId
= SqlCharT
| SqlVarCharT
| SqlLongVarCharT
| SqlWCharT
| SqlWVarCharT
| SqlWLongVarCharT
| SqlDecimalT
| SqlNumericT
| SqlSmallIntT
| SqlIntegerT
| SqlRealT
| SqlFloatT
| SqlDoubleT
| SqlBitT
| SqlTinyIntT
| SqlBigIntT
| SqlBinaryT
| SqlVarBinaryT
| SqlLongVarBinaryT
| SqlDateT
| SqlTimeT
| SqlTimestampT
| SqlUTCDateTimeT
| SqlUTCTimeT
| SqlIntervalT SqlInterval
| SqlGUIDT
| SqlUnknownT String
data SqlInterval
= SqlIntervalMonthT
| SqlIntervalYearT
| SqlIntervalYearToMonthT
| SqlIntervalDayT
| SqlIntervalHourT
| SqlIntervalMinuteT
| SqlIntervalSecondT
| SqlIntervalDayToHourT
| SqlIntervalDayToMinuteT
| SqlIntervalDayToSecondT
| SqlIntervalHourToMinuteT
| SqlIntervalHourToSecondT
| SqlIntervalMinuteToSecondT
Documentation
data SqlColDesc

The description of a column. -

Fields are Nothing if the database backend cannot supply the -requested information. -

The colSize field works like this: -

For character types, the maximum width of the column. For numeric -types, the total number of digits allowed. See the ODBC manual for more. -

The colOctetLength field is defined for character and binary types, and -gives the number of bytes the column requires, regardless of encoding. -

Constructors
SqlColDesc
colType :: SqlTypeIdType of data stored here -
colSize :: (Maybe Int)The size of a column -
colOctetLength :: (Maybe Int)The maximum size in octets -
colDecDigits :: (Maybe Int)Digits to the right of the period -
colNullable :: (Maybe Bool)Whether NULL is acceptable -
show/hide Instances
data SqlTypeId

The type identifier for a given column. -

This represents the type of data stored in the column in the underlying -SQL engine. It does not form the entire column type; see SqlColDesc for -that. -

These types correspond mainly to those defined by ODBC. -

Constructors
SqlCharTFixed-width character strings -
SqlVarCharTVariable-width character strings -
SqlLongVarCharTVariable-width character strings, max length implementation dependant -
SqlWCharTFixed-width Unicode strings -
SqlWVarCharTVariable-width Unicode strings -
SqlWLongVarCharTVariable-width Unicode strings, max length implementation dependant -
SqlDecimalTSigned exact values -
SqlNumericTSigned exact integer values -
SqlSmallIntT16-bit integer values -
SqlIntegerT32-bit integer values -
SqlRealT
SqlFloatTSigned inexact floating-point values -
SqlDoubleTSigned inexact double-precision values -
SqlBitTA single bit -
SqlTinyIntT8-bit integer values -
SqlBigIntT64-bit integer values -
SqlBinaryTFixed-length binary data -
SqlVarBinaryTVariable-length binary data -
SqlLongVarBinaryTVariable-length binary data, max length implementation dependant -
SqlDateTA date -
SqlTimeTA time -
SqlTimestampTCombined date and time -
SqlUTCDateTimeTUTC date/time -
SqlUTCTimeTUTC time -
SqlIntervalT SqlIntervalA time or date difference -
SqlGUIDTGlobal unique identifier -
SqlUnknownT StringA type not represented here; implementation-specific information in the String -
show/hide Instances
data SqlInterval
The different types of intervals in SQL. -
Constructors
SqlIntervalMonthTDifference in months -
SqlIntervalYearTDifference in years -
SqlIntervalYearToMonthTDifference in years+months -
SqlIntervalDayTDifference in days -
SqlIntervalHourTDifference in hours -
SqlIntervalMinuteTDifference in minutes -
SqlIntervalSecondTDifference in seconds -
SqlIntervalDayToHourTDifference in days+hours -
SqlIntervalDayToMinuteTDifference in days+minutes -
SqlIntervalDayToSecondTDifference in days+seconds -
SqlIntervalHourToMinuteTDifference in hours+minutes -
SqlIntervalHourToSecondTDifference in hours+seconds -
SqlIntervalMinuteToSecondTDifference in minutes+seconds -
show/hide Instances
Produced by Haddock version 0.7
diff --git a/doc/Database-HDBC-DriverUtils.html b/doc/Database-HDBC-DriverUtils.html deleted file mode 100644 --- a/doc/Database-HDBC-DriverUtils.html +++ /dev/null @@ -1,253 +0,0 @@ - - -Database.HDBC.DriverUtils
Haskell Database Connectivity (HDBC)ContentsIndex
Database.HDBC.DriverUtils
Portabilityportable
Stabilityprovisional
MaintainerJohn Goerzen <jgoerzen@complete.org>
Description

Utilities for database backend drivers. -

Please note: this module is intended for authors of database driver libraries -only. Authors of applications using HDBC should use HDBC -exclusively. -

Written by John Goerzen, jgoerzen@complete.org -

Synopsis
type ChildList = MVar [Weak Statement]
closeAllChildren :: ChildList -> IO ()
addChild :: ChildList -> Statement -> IO ()
Documentation
type ChildList = MVar [Weak Statement]
closeAllChildren :: ChildList -> IO ()

Close all children. Intended to be called by the disconnect function -in Connection. -

There may be a potential race condition wherein a call to newSth at the same -time as a call to this function may result in the new child not being closed. -

addChild :: ChildList -> Statement -> IO ()
Adds a new child to the existing list. Also takes care of registering -a finalizer for it, to remove it from the list when possible. -
Produced by Haddock version 0.7
diff --git a/doc/Database-HDBC-Types.html b/doc/Database-HDBC-Types.html deleted file mode 100644 --- a/doc/Database-HDBC-Types.html +++ /dev/null @@ -1,1799 +0,0 @@ - - -Database.HDBC.Types
Haskell Database Connectivity (HDBC)ContentsIndex
Database.HDBC.Types
Portabilityportable
Stabilityprovisional
MaintainerJohn Goerzen <jgoerzen@complete.org>
Description

Types for HDBC. -

Please note: this module is intended for authors of database driver libraries -only. Authors of applications using HDBC should use HDBC -exclusively. -

Written by John Goerzen, jgoerzen@complete.org -

Synopsis
data Connection = Connection {
disconnect :: (IO ())
commit :: (IO ())
rollback :: (IO ())
run :: (String -> [SqlValue] -> IO Integer)
prepare :: (String -> IO Statement)
clone :: (IO Connection)
hdbcDriverName :: String
hdbcClientVer :: String
proxiedClientName :: String
proxiedClientVer :: String
dbServerVer :: String
dbTransactionSupport :: Bool
getTables :: (IO [String])
describeTable :: (String -> IO [(String, SqlColDesc)])
}
data Statement = Statement {
execute :: ([SqlValue] -> IO Integer)
executeMany :: ([[SqlValue]] -> IO ())
finish :: (IO ())
fetchRow :: (IO (Maybe [SqlValue]))
getColumnNames :: (IO [String])
originalQuery :: String
describeResult :: (IO [(String, SqlColDesc)])
}
data SqlError = SqlError {
seState :: String
seNativeError :: Int
seErrorMsg :: String
}
class Show a => SqlType a where
toSql :: a -> SqlValue
fromSql :: SqlValue -> a
nToSql :: Integral a => a -> SqlValue
iToSql :: Int -> SqlValue
data SqlValue
= SqlString String
| SqlWord32 Word32
| SqlWord64 Word64
| SqlInt32 Int32
| SqlInt64 Int64
| SqlInteger Integer
| SqlChar Char
| SqlBool Bool
| SqlDouble Double
| SqlRational Rational
| SqlEpochTime Integer
| SqlTimeDiff Integer
| SqlNull
Documentation
data Connection

Main database handle object. -

A Connection object is created by specific functions in the module for an -individual database. That is, the connect function -- which creates -this object -- is not standardized through the HDBC interface. -

A connection is closed by a call to disconnect. -

A call to commit is required to make sure that your changes get committed -to the database. In other words, HDBC has no support for autocommit, which -we consider an outdated notion. -

Constructors
Connection
disconnect :: (IO ())

Disconnect from the remote database. -

You do not need to explicitly close a Connection object, but you may do so if -you so desire. If you don't, the object will disconnect from the database -in a sane way when it is garbage-collected. However, a disconnection may -raise an error, so you are encouraged to explicitly call disconnect. Also, -garbage collection may not run when the program terminates, and some databases -really like an explicit disconnect. -

So, bottom line is, you're best off calling disconnect directly, but the -world won't end if you forget. -

This function discards any data not committed already. Database driver -implementators should explicitly call rollback if their databases don't -do this automatically on disconnect. -

Bad Things (TM) could happen if you call this while you have Statements -active. In more precise language, the results in such situations are undefined -and vary by database. So don't do it. -

commit :: (IO ())

Commit any pending data to the database. -

Required to make any changes take effect. -

rollback :: (IO ())Roll back to the state the database was in prior to the - last commit or rollback. -
run :: (String -> [SqlValue] -> IO Integer)Execute a single SQL query. Returns the number - of rows modified (see execute for details). - The second parameter is a list - of replacement values, if any. -
prepare :: (String -> IO Statement)

Prepares a statement for execution. -

Question marks in the statement will be replaced by - positional parameters in a later call to execute. -

Please note that, depending on the database - and the driver, errors in your SQL may be raised - either here or by execute. Make sure you - handle exceptions both places if necessary. -

clone :: (IO Connection)

Create a new Connection object, pointed at the same - server as this object is. This will generally establish - a separate physical connection. -

When you wish to establish multiple connections to a single - server, the correct way to do so is to establish the - first connection with the driver-specific connection - function, and then clone it for each additional connection. -

This can be important when a database doesn't provide - much thread support itself, and the HDBC driver module - must serialize access to a particular database. -

This can also be a handy utility function whenever you - need a separate connection to whatever database you are - connected to already. -

hdbcDriverName :: StringThe name of the HDBC driver module for this connection. - Ideally would be the same as the database name portion - of the Cabal package name. For instance, "sqlite3" - or "odbc". This is the layer that is bound most - tightly to HDBC. -
hdbcClientVer :: StringThe version of the C (or whatever) client library - that the HDBC driver module is bound to. The meaning - of this is driver-specific. For an ODBC or similar - proxying driver, this should be the version of the - ODBC library, not the eventual DB client driver. -
proxiedClientName :: StringIn the case of a system such as ODBC, the name of - the database client/server in use, if available. - For others, - identical to hdbcDriverName. -
proxiedClientVer :: StringIn the case of a system such as ODBC, the version of - the database client in use, if available. For others, - identical to hdbcClientVer. This is the next layer - out past the HDBC driver. -
dbServerVer :: StringThe version of the database server, if available. -
dbTransactionSupport :: Bool

Whether or not the current database supports transactions. - If False, then commit and rollback should be expected - to raise errors. -

MySQL is the only commonly-used database that is known - to not support transactions entirely. Please see - the MySQL notes in the ODBC driver for more information. -

getTables :: (IO [String])

The names of all tables accessible by the current - connection, excluding special meta-tables (system tables). -

You should expect this to be returned in the same manner - as a result from fetchAllRows. -

All results should be converted to lowercase for you - before you see them. -

describeTable :: (String -> IO [(String, SqlColDesc)])

Obtain information about the columns in a specific - table. The String in the result - set is the column name. -

You should expect this to be returned in the same manner - as a result from fetchAllRows. -

All results should be converted to lowercase for you - before you see them. -

data Statement
Constructors
Statement
execute :: ([SqlValue] -> IO Integer)

Execute the prepared statement, passing in the given positional - parameters (that should take the place of the question marks - in the call to prepare). -

For non-SELECT queries, the return value is the number of - rows modified, if known. If no rows were modified, you get 0. - If the value is unknown, you get -1. All current HDBC drivers - support this function and should never return -1. -

For SELECT queries, you will always get 0. -

This function should automatically call finish() to finish the previous - execution, if necessary. -

executeMany :: ([[SqlValue]] -> IO ())

Execute the query with many rows. - The return value is the return value from the final row - as if you had called execute on it. -

Due to optimizations that are possible due to different - databases and driver designs, this can often be significantly - faster than using execute multiple times since queries - need to be compiled only once. -

This is most useful for non-SELECT statements. -

finish :: (IO ())Abort a query in progress -- usually not needed. -
fetchRow :: (IO (Maybe [SqlValue]))Fetches one row from the DB. Returns Nothing if there - are no more rows. Will automatically call finish when - the last row is read. -
getColumnNames :: (IO [String])

Returns a list of the column names in the result. - For maximum portability, you should not assume that - information is available until after an execute function - has been run. -

Information is returned here directly as returned - by the underlying database layer. Note that different - databases have different rules about capitalization - of return values and about representation of names - of columns that are not simple columns. For this reason, - it is suggested that you treat this information for - display purposes only. Failing that, you should convert - to lower (or upper) case, and use AS clauses for - anything other than simple columns. -

A simple getColumnNames implementation could simply - apply map fst to the return value of describeResult. -

originalQuery :: StringThe original query that this Statement was prepared - with. -
describeResult :: (IO [(String, SqlColDesc)])

Obtain information about the columns in the result set. - Must be run only after execute. The String in the result - set is the column name. -

You should expect this to be returned in the same manner - as a result from fetchAllRows. -

All results should be converted to lowercase for you - before you see them. -

Please see caveats under getColumnNames for information - on the column name field here. -

data SqlError

The main HDBC exception object. As much information as possible -is passed from the database through to the application through this object. -

Errors generated in the Haskell layer will have seNativeError set to -1. -

Constructors
SqlError
seState :: String
seNativeError :: Int
seErrorMsg :: String
show/hide Instances
Eq SqlError
Read SqlError
Show SqlError
Typeable SqlError
class Show a => SqlType a where

Conversions to and from SqlValues and standard Haskell types. -

Conversions are powerful; for instance, you can call fromSql on a SqlInt32 -and get a String or a Double out of it. This class attempts to Do -The Right Thing whenever possible, and will raise an error when asked to -do something incorrect. In particular, when converting to any type -except a Maybe, SqlNull as the input will cause an error to be raised. -

Here are some notes about conversion: -

  • Fractions of a second are not preserved on time values -

See also nToSql, iToSql. -

Methods
toSql :: a -> SqlValue
fromSql :: SqlValue -> a
show/hide Instances
SqlType Bool
SqlType CalendarTime
SqlType Char
SqlType ClockTime
SqlType Double
SqlType Int
SqlType Int32
SqlType Int64
SqlType Integer
SqlType Rational
SqlType String
SqlType TimeDiff
SqlType Word32
SqlType Word64
SqlType a => SqlType (Maybe a)
nToSql :: Integral a => a -> SqlValue
Converts any Integral type to a SqlValue by using toInteger. -
iToSql :: Int -> SqlValue
Convenience function for using numeric literals in your program. -
data SqlValue

The main type for expressing Haskell values to SQL databases. -

This type is used to marshall Haskell data to and from database APIs. -HDBC driver interfaces will do their best to use the most accurate and -efficient way to send a particular value to the database server. -

Values read back from the server are put in the most appropriate SqlValue -type. fromSql can then be used to convert them into whatever type -is needed locally in Haskell. -

Most people will use toSql and fromSql instead of manipulating -SqlValues directly. -

The default representation of time values is an integer number of seconds. -Databases such as PostgreSQL with builtin timestamp types can will see -automatic conversion between these Haskell types to local types. Other -databases can just use an int or a string. -

This behavior also exists for other types. For instance, many databases don't -have a Rational type, so they'll just use Haskell's show function and -store a Rational as a string. -

Two SqlValues are considered to be equal if one of these hold (first one that -is true holds; if none are true, they are not equal): - * Both are NULL - * Both represent the same type and the encapsulated values are equal - * The values of each, when converted to a string, are equal. -

Constructors
SqlString String
SqlWord32 Word32
SqlWord64 Word64
SqlInt32 Int32
SqlInt64 Int64
SqlInteger Integer
SqlChar Char
SqlBool Bool
SqlDouble Double
SqlRational Rational
SqlEpochTime IntegerRepresentation of ClockTime or CalendarTime -
SqlTimeDiff IntegerRepresentation of TimeDiff -
SqlNullNULL in SQL or Nothing in Haskell -
show/hide Instances
Produced by Haddock version 0.7
diff --git a/doc/Database-HDBC.html b/doc/Database-HDBC.html deleted file mode 100644 --- a/doc/Database-HDBC.html +++ /dev/null @@ -1,3433 +0,0 @@ - - -Database.HDBC
Haskell Database Connectivity (HDBC)ContentsIndex
Database.HDBC
Portabilityportable
Stabilityprovisional
MaintainerJohn Goerzen <jgoerzen@complete.org>
Contents
Introduction -
Features -
Available Drivers -
Typing of transfer data -
Database Connections -
Preparing Queries -
Transaction Handling -
Connection Inquiries -
Statements -
Execution -
Fetching Results -
Statement Inquires -
Miscellaneous -
Exceptions -
Column Types -
Threading -
Copyright and License -
Description

Welcome to HDBC, the Haskell Database Connectivity library. -

Written by John Goerzen, jgoerzen@complete.org -

Synopsis
class Show a => SqlType a where
toSql :: a -> SqlValue
fromSql :: SqlValue -> a
nToSql :: Integral a => a -> SqlValue
iToSql :: Int -> SqlValue
data SqlValue
= SqlString String
| SqlWord32 Word32
| SqlWord64 Word64
| SqlInt32 Int32
| SqlInt64 Int64
| SqlInteger Integer
| SqlChar Char
| SqlBool Bool
| SqlDouble Double
| SqlRational Rational
| SqlEpochTime Integer
| SqlTimeDiff Integer
| SqlNull
data Connection
disconnect :: Connection -> IO ()
clone :: Connection -> IO Connection
run :: Connection -> String -> [SqlValue] -> IO Integer
sRun :: Connection -> String -> [Maybe String] -> IO Integer
prepare :: Connection -> String -> IO Statement
quickQuery :: Connection -> String -> [SqlValue] -> IO [[SqlValue]]
commit :: Connection -> IO ()
rollback :: Connection -> IO ()
withTransaction :: Connection -> (Connection -> IO a) -> IO a
hdbcDriverName :: Connection -> String
hdbcClientVer :: Connection -> String
proxiedClientName :: Connection -> String
proxiedClientVer :: Connection -> String
dbServerVer :: Connection -> String
dbTransactionSupport :: Connection -> Bool
getTables :: Connection -> IO [String]
describeTable :: Connection -> String -> IO [(String, SqlColDesc)]
data Statement
execute :: Statement -> [SqlValue] -> IO Integer
sExecute :: Statement -> [Maybe String] -> IO Integer
executeMany :: Statement -> [[SqlValue]] -> IO ()
sExecuteMany :: Statement -> [[Maybe String]] -> IO ()
fetchRow :: Statement -> IO (Maybe [SqlValue])
fetchRowAL :: Statement -> IO (Maybe [(String, SqlValue)])
fetchRowMap :: Statement -> IO (Maybe (Map String SqlValue))
sFetchRow :: Statement -> IO (Maybe [Maybe String])
fetchAllRows :: Statement -> IO [[SqlValue]]
fetchAllRowsAL :: Statement -> IO [[(String, SqlValue)]]
fetchAllRowsMap :: Statement -> IO [Map String SqlValue]
sFetchAllRows :: Statement -> IO [[Maybe String]]
getColumnNames :: Statement -> IO [String]
describeResult :: Statement -> IO [(String, SqlColDesc)]
finish :: Statement -> IO ()
originalQuery :: Statement -> String
data SqlError = SqlError {
seState :: String
seNativeError :: Int
seErrorMsg :: String
}
catchSql :: IO a -> (SqlError -> IO a) -> IO a
handleSql :: (SqlError -> IO a) -> IO a -> IO a
sqlExceptions :: Exception -> Maybe SqlError
handleSqlError :: IO a -> IO a
module Database.HDBC.ColTypes
Introduction -

Welcome to HDBC, Haskell Database Connectivity. -

HDBC provides an abstraction layer between Haskell programs and SQL -relational databases. This lets you write database code once, in -Haskell, and have it work with any number of backend SQL databases -(MySQL, Oracle, PostgreSQL, ODBC-compliant databases, etc.) -

HDBC is modeled loosely on Perl's DBI interface -http://search.cpan.org/~timb/DBI/DBI.pm, though it has also -been influenced by Python's DB-API v2, JDBC in Java, and HSQL in -Haskell. -

HDBC is a from-scratch effort. It is not a reimplementation of HSQL, -though its purpose is the same. -

Features -

Features of HDBC include: -

  • Ability to use replacable parameters to let one query be - executed multiple times (eliminates the need for an escape - function) -
  • Ability to access returned rows by column number -
  • Ability to read data from the SQL server on-demand rather than - reading the entire result set up front -
  • HUnit testsuite for each backend driver -
  • Well-defined standard API and easy backend driver implementation -
  • Lazy reading of the entire result set (think hGetContents, but - for the results of SELECT) (see sFetchAllRows) -
  • Support for translation between Haskell and SQL types -
  • Support for querying database server properties -
  • Add-on package (hdbc-missingh) to integrate with MissingH, - providing a database backend for AnyDBM. -
  • Support for querying metadata such as column names. -
  • Support for querying additional metadata (column types, etc.) -
Available Drivers -

Here is a list of known drivers as of March 28, 2006: -

Sqlite v3
Available from http://quux.org/devel/hdbc. Or, to -participate in development, use -darcs get --partial http://darcs.complete.org/hdbc-sqlite3 -
PostgreSQL
Available from http://quux.org/devel/hdbc. Or, to -participate in development, use -darcs get --partial http://darcs.complete.org/hdbc-postgresql -
ODBC
Available from http://quux.org/devel/hdbc. Or, to -partitipace in development, use -darcs get --partial http://darcs.complete.org/hdbc-odbc -
MySQL
MySQL users are encouraged to use the ODBC driver, which works -and has been tested against MySQL on both Linux/Unix and Windows platforms. -

In addition, there is one integration package: hdbc-missingh. This -integrates with the MissingH library http://quux.org/devel/missingh. -Among other things, it lets any HDBC database act as a backend for the -AnyDBM interface. Available from http://quux.org/devel/hdbc. Or, -to participate in development, use -darcs get --partial http://darcs.complete.org/hdbc-missingh -

The latest version of HDBC itself is available from -http://quux.org/devel/hdbc. Or, to participate in development, use -darcs get --partial http://darcs.complete.org/hdbc. -

Typing of transfer data -
class Show a => SqlType a where

Conversions to and from SqlValues and standard Haskell types. -

Conversions are powerful; for instance, you can call fromSql on a SqlInt32 -and get a String or a Double out of it. This class attempts to Do -The Right Thing whenever possible, and will raise an error when asked to -do something incorrect. In particular, when converting to any type -except a Maybe, SqlNull as the input will cause an error to be raised. -

Here are some notes about conversion: -

  • Fractions of a second are not preserved on time values -

See also nToSql, iToSql. -

Methods
toSql :: a -> SqlValue
fromSql :: SqlValue -> a
show/hide Instances
SqlType Bool
SqlType CalendarTime
SqlType Char
SqlType ClockTime
SqlType Double
SqlType Int
SqlType Int32
SqlType Int64
SqlType Integer
SqlType Rational
SqlType String
SqlType TimeDiff
SqlType Word32
SqlType Word64
SqlType a => SqlType (Maybe a)
nToSql :: Integral a => a -> SqlValue
Converts any Integral type to a SqlValue by using toInteger. -
iToSql :: Int -> SqlValue
Convenience function for using numeric literals in your program. -
data SqlValue

The main type for expressing Haskell values to SQL databases. -

This type is used to marshall Haskell data to and from database APIs. -HDBC driver interfaces will do their best to use the most accurate and -efficient way to send a particular value to the database server. -

Values read back from the server are put in the most appropriate SqlValue -type. fromSql can then be used to convert them into whatever type -is needed locally in Haskell. -

Most people will use toSql and fromSql instead of manipulating -SqlValues directly. -

The default representation of time values is an integer number of seconds. -Databases such as PostgreSQL with builtin timestamp types can will see -automatic conversion between these Haskell types to local types. Other -databases can just use an int or a string. -

This behavior also exists for other types. For instance, many databases don't -have a Rational type, so they'll just use Haskell's show function and -store a Rational as a string. -

Two SqlValues are considered to be equal if one of these hold (first one that -is true holds; if none are true, they are not equal): - * Both are NULL - * Both represent the same type and the encapsulated values are equal - * The values of each, when converted to a string, are equal. -

Constructors
SqlString String
SqlWord32 Word32
SqlWord64 Word64
SqlInt32 Int32
SqlInt64 Int64
SqlInteger Integer
SqlChar Char
SqlBool Bool
SqlDouble Double
SqlRational Rational
SqlEpochTime IntegerRepresentation of ClockTime or CalendarTime -
SqlTimeDiff IntegerRepresentation of TimeDiff -
SqlNullNULL in SQL or Nothing in Haskell -
show/hide Instances
Database Connections -
data Connection

Main database handle object. -

A Connection object is created by specific functions in the module for an -individual database. That is, the connect function -- which creates -this object -- is not standardized through the HDBC interface. -

A connection is closed by a call to disconnect. -

A call to commit is required to make sure that your changes get committed -to the database. In other words, HDBC has no support for autocommit, which -we consider an outdated notion. -

disconnect :: Connection -> IO ()

Disconnect from the remote database. -

You do not need to explicitly close a Connection object, but you may do so if -you so desire. If you don't, the object will disconnect from the database -in a sane way when it is garbage-collected. However, a disconnection may -raise an error, so you are encouraged to explicitly call disconnect. Also, -garbage collection may not run when the program terminates, and some databases -really like an explicit disconnect. -

So, bottom line is, you're best off calling disconnect directly, but the -world won't end if you forget. -

This function discards any data not committed already. Database driver -implementators should explicitly call rollback if their databases don't -do this automatically on disconnect. -

Bad Things (TM) could happen if you call this while you have Statements -active. In more precise language, the results in such situations are undefined -and vary by database. So don't do it. -

clone :: Connection -> IO Connection

Create a new Connection object, pointed at the same - server as this object is. This will generally establish - a separate physical connection. -

When you wish to establish multiple connections to a single - server, the correct way to do so is to establish the - first connection with the driver-specific connection - function, and then clone it for each additional connection. -

This can be important when a database doesn't provide - much thread support itself, and the HDBC driver module - must serialize access to a particular database. -

This can also be a handy utility function whenever you - need a separate connection to whatever database you are - connected to already. -

Preparing Queries -
run :: Connection -> String -> [SqlValue] -> IO Integer
Execute a single SQL query. Returns the number - of rows modified (see execute for details). - The second parameter is a list - of replacement values, if any. -
sRun :: Connection -> String -> [Maybe String] -> IO Integer
Like run, but take a list of Maybe Strings instead of SqlValues. -
prepare :: Connection -> String -> IO Statement

Prepares a statement for execution. -

Question marks in the statement will be replaced by - positional parameters in a later call to execute. -

Please note that, depending on the database - and the driver, errors in your SQL may be raised - either here or by execute. Make sure you - handle exceptions both places if necessary. -

quickQuery :: Connection -> String -> [SqlValue] -> IO [[SqlValue]]
A quick way to do a query. Similar to preparing, executing, and -then calling fetchAllRows on a statement. -
Transaction Handling -

This section concerns itself with writing (updating) a database. -

In HDBC, as with many RDBMS implementations, every write to the -database occurs within a transaction. No changes are visible (outside -the current transaction) until a commit operation occurs, in which -case all changes since the transaction started are atomically -committed. Also, there is a rollback operation that can undo all -changes since the transaction started. -

HDBC does everything within a transaction. A transaction is implicitly entered -when a connection to a database is established, and a transaction is -implicitly entered after each call to commit or rollback as well. -

The practical effect of this is that you must call commit after making -changes to a database in order for those changes to become visible. You don't -have to call commit after every change, just after a batch of them. -

(Exceptions exist for databases that don't offer a high level of transaction -isolation; but you should always play it safe and commit anyway.) -

Database developers will also be experienced with the atomicity benefits -of transactions, an explanation of which is outside the scope of this manual. -

Errors occuring at the database level can leave a transaction in an -indeterminate state, depending on the database. Some databases will -refuse all queries until the next commit or rollback. The safe thing -to do is to issue a commit or rollback after trapping any SqlError. -Alternatively, you could use withTransaction, which will automatically -handle this detail for you. -

commit :: Connection -> IO ()

Commit any pending data to the database. -

Required to make any changes take effect. -

rollback :: Connection -> IO ()
Roll back to the state the database was in prior to the - last commit or rollback. -
withTransaction :: Connection -> (Connection -> IO a) -> IO a

Execute some code. If any uncaught exception occurs, run -rollback and re-raise it. Otherwise, run commit and return. -

This function, therefore, encapsulates the logical property that a transaction -is all about: all or nothing. -

The Connection object passed in is passed directly to the specified -function as a convenience. -

This function traps all uncaught exceptions, not just SqlErrors. Therefore, -you will get a rollback for any exception that you don't handle. That's -probably what you want anyway. -

Since all operations in HDBC are done in a transaction, this function doesn't -issue an explicit "begin" to the server. You should ideally have -called commit or rollback before -calling this function. If you haven't, this function will commit or rollback -more than just the changes made in the included action. -

If there was an error while running rollback, this error will not be -reported since the original exception will be propogated back. (You'd probably -like to know about the root cause for all of this anyway.) Feedback -on this behavior is solicited. -

Connection Inquiries -
hdbcDriverName :: Connection -> String
The name of the HDBC driver module for this connection. - Ideally would be the same as the database name portion - of the Cabal package name. For instance, "sqlite3" - or "odbc". This is the layer that is bound most - tightly to HDBC. -
hdbcClientVer :: Connection -> String
The version of the C (or whatever) client library - that the HDBC driver module is bound to. The meaning - of this is driver-specific. For an ODBC or similar - proxying driver, this should be the version of the - ODBC library, not the eventual DB client driver. -
proxiedClientName :: Connection -> String
In the case of a system such as ODBC, the name of - the database client/server in use, if available. - For others, - identical to hdbcDriverName. -
proxiedClientVer :: Connection -> String
In the case of a system such as ODBC, the version of - the database client in use, if available. For others, - identical to hdbcClientVer. This is the next layer - out past the HDBC driver. -
dbServerVer :: Connection -> String
The version of the database server, if available. -
dbTransactionSupport :: Connection -> Bool

Whether or not the current database supports transactions. - If False, then commit and rollback should be expected - to raise errors. -

MySQL is the only commonly-used database that is known - to not support transactions entirely. Please see - the MySQL notes in the ODBC driver for more information. -

getTables :: Connection -> IO [String]

The names of all tables accessible by the current - connection, excluding special meta-tables (system tables). -

You should expect this to be returned in the same manner - as a result from fetchAllRows. -

All results should be converted to lowercase for you - before you see them. -

describeTable :: Connection -> String -> IO [(String, SqlColDesc)]

Obtain information about the columns in a specific - table. The String in the result - set is the column name. -

You should expect this to be returned in the same manner - as a result from fetchAllRows. -

All results should be converted to lowercase for you - before you see them. -

Statements -
data Statement
Execution -
execute :: Statement -> [SqlValue] -> IO Integer

Execute the prepared statement, passing in the given positional - parameters (that should take the place of the question marks - in the call to prepare). -

For non-SELECT queries, the return value is the number of - rows modified, if known. If no rows were modified, you get 0. - If the value is unknown, you get -1. All current HDBC drivers - support this function and should never return -1. -

For SELECT queries, you will always get 0. -

This function should automatically call finish() to finish the previous - execution, if necessary. -

sExecute :: Statement -> [Maybe String] -> IO Integer
Like execute, but take a list of Maybe Strings instead of - SqlValues. -
executeMany :: Statement -> [[SqlValue]] -> IO ()

Execute the query with many rows. - The return value is the return value from the final row - as if you had called execute on it. -

Due to optimizations that are possible due to different - databases and driver designs, this can often be significantly - faster than using execute multiple times since queries - need to be compiled only once. -

This is most useful for non-SELECT statements. -

sExecuteMany :: Statement -> [[Maybe String]] -> IO ()
Like executeMany, but take a list of Maybe Strings instead of - SqlValues. -
Fetching Results -
fetchRow :: Statement -> IO (Maybe [SqlValue])
Fetches one row from the DB. Returns Nothing if there - are no more rows. Will automatically call finish when - the last row is read. -
fetchRowAL :: Statement -> IO (Maybe [(String, SqlValue)])

Like fetchRow, but instead of returning a list, return an association -list from column name to value. -

The keys of the column names are lowercase versions of the data returned -by getColumnNames. Please heed the warnings there. Additionally, -results are undefined if multiple columns are returned with identical names. -

fetchRowMap :: Statement -> IO (Maybe (Map String SqlValue))
Similar to fetchRowAL, but return a Map instead of an association list. -
sFetchRow :: Statement -> IO (Maybe [Maybe String])
Like fetchRow, but return a list of Maybe Strings instead of - SqlValues. -
fetchAllRows :: Statement -> IO [[SqlValue]]

Lazily fetch all rows from an executed Statement. -

You can think of this as hGetContents applied to a database result set. -

The result of this is a lazy list, and each new row will be read, lazily, from -the database as the list is processed. -

When you have exhausted the list, the Statement will be finished. -

Please note that the careless use of this function can lead to some unpleasant -behavior. In particular, if you have not consumed the entire list, then -attempt to finish or re-execute the statement, and then attempt to consume -more elements from the list, the result will almost certainly not be what -you want. -

But then, similar caveats apply with hGetContents. -

Bottom line: this is a very convenient abstraction; use it wisely. -

fetchAllRowsAL :: Statement -> IO [[(String, SqlValue)]]

Like fetchAllRows, but instead of returning a list for each -row, return an association list for each row, from column name to value. -

See fetchRowAL for more details. -

fetchAllRowsMap :: Statement -> IO [Map String SqlValue]
Like fetchAllRowsAL, but return a list of Maps instead of a list of -association lists. -
sFetchAllRows :: Statement -> IO [[Maybe String]]
Like fetchAllRows, but return Maybe Strings instead of SqlValues. -
getColumnNames :: Statement -> IO [String]

Returns a list of the column names in the result. - For maximum portability, you should not assume that - information is available until after an execute function - has been run. -

Information is returned here directly as returned - by the underlying database layer. Note that different - databases have different rules about capitalization - of return values and about representation of names - of columns that are not simple columns. For this reason, - it is suggested that you treat this information for - display purposes only. Failing that, you should convert - to lower (or upper) case, and use AS clauses for - anything other than simple columns. -

A simple getColumnNames implementation could simply - apply map fst to the return value of describeResult. -

Statement Inquires -
describeResult :: Statement -> IO [(String, SqlColDesc)]

Obtain information about the columns in the result set. - Must be run only after execute. The String in the result - set is the column name. -

You should expect this to be returned in the same manner - as a result from fetchAllRows. -

All results should be converted to lowercase for you - before you see them. -

Please see caveats under getColumnNames for information - on the column name field here. -

Miscellaneous -
finish :: Statement -> IO ()
Abort a query in progress -- usually not needed. -
originalQuery :: Statement -> String
The original query that this Statement was prepared - with. -
Exceptions -
data SqlError

The main HDBC exception object. As much information as possible -is passed from the database through to the application through this object. -

Errors generated in the Haskell layer will have seNativeError set to -1. -

Constructors
SqlError
seState :: String
seNativeError :: Int
seErrorMsg :: String
show/hide Instances
Eq SqlError
Read SqlError
Show SqlError
Typeable SqlError
catchSql :: IO a -> (SqlError -> IO a) -> IO a

Execute the given IO action. -

If it raises a SqlError, then execute the supplied handler and return its -return value. Otherwise, proceed as normal. -

handleSql :: (SqlError -> IO a) -> IO a -> IO a
Like catchSql, with the order of arguments reversed. -
sqlExceptions :: Exception -> Maybe SqlError
Given an Exception, return Just SqlError if it was an SqlError, or Nothing -otherwise. Useful with functions like catchJust. -
handleSqlError :: IO a -> IO a
Catches SqlErrors, and re-raises them as IO errors with fail. -Useful if you don't care to catch SQL errors, but want to see a sane -error message if one happens. One would often use this as a high-level -wrapper around SQL calls. -
Column Types -
These are defined in Database.HDBC.ColTypes but are - available to programs importing Database.HDBC by default as well. - See Database.HDBC.ColTypes for documentation. -
module Database.HDBC.ColTypes
Threading -

FIXME: this is draft information -

Thread support in a generalized interface such as HDBC can be complicated -because support for threading varies across database interfaces. -

However, applications using HDBC should be able to rely upon at least a few -basic guarantees: -

  • The HDBC modules may freely be imported and used across all threads. -
  • HDBC modules may also freely share database connections and statements; - the database or HDBC driver will be responsible for locking if necessary. -

I use "share" in the same sense as Python's DB-API: multiple threads may use -the resource without wrapping it in any lock. -

However, there are some caveats to the above: -

  • Not all databases support more than one active statement for a single - connection. Therefore, for maximum portability, you should use - a different connection to the database for each simultaneous query you - wish to use. - FIXME: describe when a statement is active. -
  • Not all databases may support the level of multithreading described above. - For those that don't, safe access will be restriced in the HDBC driver - by using locks. Therefore, you can write portable code, but you - only get real multithreading when databases really support it. - Details of thread support should be documented in the HDBC - driver for each specific database. -
Copyright and License -

Copyright (C) 2005-2006 John Goerzen jgoerzen@complete.org -

This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation; either -version 2.1 of the License, or (at your option) any later version. -

This library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. -

You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -

Please see COPYING in the source distribution for the full license. -

Produced by Haddock version 0.7
diff --git a/doc/doc-index-A.html b/doc/doc-index-A.html deleted file mode 100644 --- a/doc/doc-index-A.html +++ /dev/null @@ -1,126 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (A)
addChildDatabase.HDBC.DriverUtils
diff --git a/doc/doc-index-C.html b/doc/doc-index-C.html deleted file mode 100644 --- a/doc/doc-index-C.html +++ /dev/null @@ -1,224 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (C)
ChildListDatabase.HDBC.DriverUtils
Connection
1 (Type/Class)Database.HDBC.Types, Database.HDBC
2 (Data Constructor)Database.HDBC.Types
catchSqlDatabase.HDBC
cloneDatabase.HDBC.Types, Database.HDBC
closeAllChildrenDatabase.HDBC.DriverUtils
colDecDigitsDatabase.HDBC.ColTypes, Database.HDBC
colNullableDatabase.HDBC.ColTypes, Database.HDBC
colOctetLengthDatabase.HDBC.ColTypes, Database.HDBC
colSizeDatabase.HDBC.ColTypes, Database.HDBC
colTypeDatabase.HDBC.ColTypes, Database.HDBC
commitDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-D.html b/doc/doc-index-D.html deleted file mode 100644 --- a/doc/doc-index-D.html +++ /dev/null @@ -1,168 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (D)
dbServerVerDatabase.HDBC.Types, Database.HDBC
dbTransactionSupportDatabase.HDBC.Types, Database.HDBC
describeResultDatabase.HDBC.Types, Database.HDBC
describeTableDatabase.HDBC.Types, Database.HDBC
disconnectDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-E.html b/doc/doc-index-E.html deleted file mode 100644 --- a/doc/doc-index-E.html +++ /dev/null @@ -1,138 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (E)
executeDatabase.HDBC.Types, Database.HDBC
executeManyDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-F.html b/doc/doc-index-F.html deleted file mode 100644 --- a/doc/doc-index-F.html +++ /dev/null @@ -1,188 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (F)
fetchAllRowsDatabase.HDBC
fetchAllRowsALDatabase.HDBC
fetchAllRowsMapDatabase.HDBC
fetchRowDatabase.HDBC.Types, Database.HDBC
fetchRowALDatabase.HDBC
fetchRowMapDatabase.HDBC
finishDatabase.HDBC.Types, Database.HDBC
fromSqlDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-G.html b/doc/doc-index-G.html deleted file mode 100644 --- a/doc/doc-index-G.html +++ /dev/null @@ -1,138 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (G)
getColumnNamesDatabase.HDBC.Types, Database.HDBC
getTablesDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-H.html b/doc/doc-index-H.html deleted file mode 100644 --- a/doc/doc-index-H.html +++ /dev/null @@ -1,154 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (H)
handleSqlDatabase.HDBC
handleSqlErrorDatabase.HDBC
hdbcClientVerDatabase.HDBC.Types, Database.HDBC
hdbcDriverNameDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-I.html b/doc/doc-index-I.html deleted file mode 100644 --- a/doc/doc-index-I.html +++ /dev/null @@ -1,128 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (I)
iToSqlDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-N.html b/doc/doc-index-N.html deleted file mode 100644 --- a/doc/doc-index-N.html +++ /dev/null @@ -1,128 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (N)
nToSqlDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-O.html b/doc/doc-index-O.html deleted file mode 100644 --- a/doc/doc-index-O.html +++ /dev/null @@ -1,128 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (O)
originalQueryDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-P.html b/doc/doc-index-P.html deleted file mode 100644 --- a/doc/doc-index-P.html +++ /dev/null @@ -1,148 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (P)
prepareDatabase.HDBC.Types, Database.HDBC
proxiedClientNameDatabase.HDBC.Types, Database.HDBC
proxiedClientVerDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-Q.html b/doc/doc-index-Q.html deleted file mode 100644 --- a/doc/doc-index-Q.html +++ /dev/null @@ -1,126 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (Q)
quickQueryDatabase.HDBC
diff --git a/doc/doc-index-R.html b/doc/doc-index-R.html deleted file mode 100644 --- a/doc/doc-index-R.html +++ /dev/null @@ -1,138 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (R)
rollbackDatabase.HDBC.Types, Database.HDBC
runDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-S.html b/doc/doc-index-S.html deleted file mode 100644 --- a/doc/doc-index-S.html +++ /dev/null @@ -1,748 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (S)
SqlBigIntTDatabase.HDBC.ColTypes, Database.HDBC
SqlBinaryTDatabase.HDBC.ColTypes, Database.HDBC
SqlBitTDatabase.HDBC.ColTypes, Database.HDBC
SqlBoolDatabase.HDBC.Types, Database.HDBC
SqlCharDatabase.HDBC.Types, Database.HDBC
SqlCharTDatabase.HDBC.ColTypes, Database.HDBC
SqlColDesc
1 (Type/Class)Database.HDBC.ColTypes, Database.HDBC
2 (Data Constructor)Database.HDBC.ColTypes, Database.HDBC
SqlDateTDatabase.HDBC.ColTypes, Database.HDBC
SqlDecimalTDatabase.HDBC.ColTypes, Database.HDBC
SqlDoubleDatabase.HDBC.Types, Database.HDBC
SqlDoubleTDatabase.HDBC.ColTypes, Database.HDBC
SqlEpochTimeDatabase.HDBC.Types, Database.HDBC
SqlError
1 (Type/Class)Database.HDBC.Types, Database.HDBC
2 (Data Constructor)Database.HDBC.Types, Database.HDBC
SqlFloatTDatabase.HDBC.ColTypes, Database.HDBC
SqlGUIDTDatabase.HDBC.ColTypes, Database.HDBC
SqlInt32Database.HDBC.Types, Database.HDBC
SqlInt64Database.HDBC.Types, Database.HDBC
SqlIntegerDatabase.HDBC.Types, Database.HDBC
SqlIntegerTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalDayTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalDayToHourTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalDayToMinuteTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalDayToSecondTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalHourTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalHourToMinuteTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalHourToSecondTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalMinuteTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalMinuteToSecondTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalMonthTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalSecondTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalYearTDatabase.HDBC.ColTypes, Database.HDBC
SqlIntervalYearToMonthTDatabase.HDBC.ColTypes, Database.HDBC
SqlLongVarBinaryTDatabase.HDBC.ColTypes, Database.HDBC
SqlLongVarCharTDatabase.HDBC.ColTypes, Database.HDBC
SqlNullDatabase.HDBC.Types, Database.HDBC
SqlNumericTDatabase.HDBC.ColTypes, Database.HDBC
SqlRationalDatabase.HDBC.Types, Database.HDBC
SqlRealTDatabase.HDBC.ColTypes, Database.HDBC
SqlSmallIntTDatabase.HDBC.ColTypes, Database.HDBC
SqlStringDatabase.HDBC.Types, Database.HDBC
SqlTimeDiffDatabase.HDBC.Types, Database.HDBC
SqlTimeTDatabase.HDBC.ColTypes, Database.HDBC
SqlTimestampTDatabase.HDBC.ColTypes, Database.HDBC
SqlTinyIntTDatabase.HDBC.ColTypes, Database.HDBC
SqlTypeDatabase.HDBC.Types, Database.HDBC
SqlTypeIdDatabase.HDBC.ColTypes, Database.HDBC
SqlUTCDateTimeTDatabase.HDBC.ColTypes, Database.HDBC
SqlUTCTimeTDatabase.HDBC.ColTypes, Database.HDBC
SqlUnknownTDatabase.HDBC.ColTypes, Database.HDBC
SqlValueDatabase.HDBC.Types, Database.HDBC
SqlVarBinaryTDatabase.HDBC.ColTypes, Database.HDBC
SqlVarCharTDatabase.HDBC.ColTypes, Database.HDBC
SqlWCharTDatabase.HDBC.ColTypes, Database.HDBC
SqlWLongVarCharTDatabase.HDBC.ColTypes, Database.HDBC
SqlWVarCharTDatabase.HDBC.ColTypes, Database.HDBC
SqlWord32Database.HDBC.Types, Database.HDBC
SqlWord64Database.HDBC.Types, Database.HDBC
Statement
1 (Type/Class)Database.HDBC.Types, Database.HDBC
2 (Data Constructor)Database.HDBC.Types
sExecuteDatabase.HDBC
sExecuteManyDatabase.HDBC
sFetchAllRowsDatabase.HDBC
sFetchRowDatabase.HDBC
sRunDatabase.HDBC
seErrorMsgDatabase.HDBC.Types, Database.HDBC
seNativeErrorDatabase.HDBC.Types, Database.HDBC
seStateDatabase.HDBC.Types, Database.HDBC
sqlExceptionsDatabase.HDBC
diff --git a/doc/doc-index-T.html b/doc/doc-index-T.html deleted file mode 100644 --- a/doc/doc-index-T.html +++ /dev/null @@ -1,128 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (T)
toSqlDatabase.HDBC.Types, Database.HDBC
diff --git a/doc/doc-index-W.html b/doc/doc-index-W.html deleted file mode 100644 --- a/doc/doc-index-W.html +++ /dev/null @@ -1,126 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
ACDEFGHINOPQRSTW
Index (W)
withTransactionDatabase.HDBC
diff --git a/doc/doc-index.html b/doc/doc-index.html deleted file mode 100644 --- a/doc/doc-index.html +++ /dev/null @@ -1,112 +0,0 @@ - - -Haskell Database Connectivity (HDBC) (Index)
Haskell Database Connectivity (HDBC)ContentsIndex
Index
ACDEFGHINOPQRSTW
diff --git a/doc/haddock.css b/doc/haddock.css deleted file mode 100644 --- a/doc/haddock.css +++ /dev/null @@ -1,235 +0,0 @@ -/* -------- Global things --------- */ - -BODY { - background-color: #ffffff; - color: #000000; - font-family: sans-serif; - } - -A:link { color: #0000e0; text-decoration: none } -A:visited { color: #0000a0; text-decoration: none } -A:hover { background-color: #e0e0ff; text-decoration: none } - -TABLE.vanilla { - width: 100%; - border-width: 0px; - /* I can't seem to specify cellspacing or cellpadding properly using CSS... */ -} - -TABLE.vanilla2 { - border-width: 0px; -} - -/* font is a little too small in MSIE */ -TT { font-size: 100%; } -PRE { font-size: 100%; } - -LI P { margin: 0pt } - -TD { - border-width: 0px; -} - -TABLE.narrow { - border-width: 0px; -} - -TD.s8 { height: 8px; } -TD.s15 { height: 15px; } - -SPAN.keyword { text-decoration: underline; } - -/* Resize the buttom image to match the text size */ -IMG.coll { width : 0.75em; height: 0.75em; margin-bottom: 0; margin-right: 0.5em } - -/* --------- Contents page ---------- */ - -DIV.node { - padding-left: 3em; -} - -DIV.cnode { - padding-left: 1.75em; -} - -SPAN.pkg { - position: absolute; - left: 50em; -} - -/* --------- Documentation elements ---------- */ - -TD.children { - padding-left: 25px; - } - -TD.synopsis { - padding: 2px; - background-color: #f0f0f0; - font-family: monospace - } - -TD.decl { - padding: 2px; - background-color: #f0f0f0; - font-family: monospace; - vertical-align: top; - } - -/* - arg is just like decl, except that wrapping is not allowed. It is - used for function and constructor arguments which have a text box - to the right, where if wrapping is allowed the text box squashes up - the declaration by wrapping it. -*/ -TD.arg { - padding: 2px; - background-color: #f0f0f0; - font-family: monospace; - vertical-align: top; - white-space: nowrap; - } - -TD.recfield { padding-left: 20px } - -TD.doc { - padding-top: 2px; - padding-left: 10px; - } - -TD.ndoc { - padding: 2px; - } - -TD.rdoc { - padding: 2px; - padding-left: 10px; - width: 100%; - } - -TD.body { - padding-left: 10px - } - -TD.pkg { - width: 100%; - padding-left: 10px -} - -TD.indexentry { - vertical-align: top; - padding-right: 10px - } - -TD.indexannot { - vertical-align: top; - padding-left: 20px; - white-space: nowrap - } - -TD.indexlinks { - width: 100% - } - -/* ------- Section Headings ------- */ - -TD.section1 { - padding-top: 15px; - font-weight: bold; - font-size: 150% - } - -TD.section2 { - padding-top: 10px; - font-weight: bold; - font-size: 130% - } - -TD.section3 { - padding-top: 5px; - font-weight: bold; - font-size: 110% - } - -TD.section4 { - font-weight: bold; - font-size: 100% - } - -/* -------------- The title bar at the top of the page */ - -TD.infohead { - color: #ffffff; - font-weight: bold; - padding-right: 10px; - text-align: left; -} - -TD.infoval { - color: #ffffff; - padding-right: 10px; - text-align: left; -} - -TD.topbar { - background-color: #000099; - padding: 5px; -} - -TD.title { - color: #ffffff; - padding-left: 10px; - width: 100% - } - -TD.topbut { - padding-left: 5px; - padding-right: 5px; - border-left-width: 1px; - border-left-color: #ffffff; - border-left-style: solid; - white-space: nowrap; - } - -TD.topbut A:link { - color: #ffffff - } - -TD.topbut A:visited { - color: #ffff00 - } - -TD.topbut A:hover { - background-color: #6060ff; - } - -TD.topbut:hover { - background-color: #6060ff - } - -TD.modulebar { - background-color: #0077dd; - padding: 5px; - border-top-width: 1px; - border-top-color: #ffffff; - border-top-style: solid; - } - -/* --------- The page footer --------- */ - -TD.botbar { - background-color: #000099; - color: #ffffff; - padding: 5px - } -TD.botbar A:link { - color: #ffffff; - text-decoration: underline - } -TD.botbar A:visited { - color: #ffff00 - } -TD.botbar A:hover { - background-color: #6060ff - } - diff --git a/doc/haddock.js b/doc/haddock.js deleted file mode 100644 --- a/doc/haddock.js +++ /dev/null @@ -1,15 +0,0 @@ -// Haddock JavaScript utilities -function toggle(button,id) -{ - var n = document.getElementById(id).style; - if (n.display == "none") - { - button.src = "minus.gif"; - n.display = "block"; - } - else - { - button.src = "plus.gif"; - n.display = "none"; - } -} diff --git a/doc/haskell_icon.gif b/doc/haskell_icon.gif deleted file mode 100644 Binary files a/doc/haskell_icon.gif and /dev/null differ diff --git a/doc/hdbc.interface b/doc/hdbc.interface deleted file mode 100644 Binary files a/doc/hdbc.interface and /dev/null differ diff --git a/doc/index.html b/doc/index.html deleted file mode 100644 --- a/doc/index.html +++ /dev/null @@ -1,120 +0,0 @@ - - -Haskell Database Connectivity (HDBC)
Haskell Database Connectivity (HDBC)ContentsIndex
Modules
show/hideDatabase
show/hideDatabase.HDBC
Database.HDBC.ColTypes
Database.HDBC.DriverUtils
Database.HDBC.Types
Produced by Haddock version 0.7
diff --git a/doc/minus.gif b/doc/minus.gif deleted file mode 100644 Binary files a/doc/minus.gif and /dev/null differ diff --git a/doc/plus.gif b/doc/plus.gif deleted file mode 100644 Binary files a/doc/plus.gif and /dev/null differ