-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | 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.)
@package HDBC
@version 1.1.6


-- | Definitions of, and utilities for, specifying what type of data is
--   represented by a column.
--   
--   Written by John Goerzen, jgoerzen@complete.org
module Database.HDBC.ColTypes

-- | 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.
data SqlColDesc
SqlColDesc :: SqlTypeId -> Maybe Int -> Maybe Int -> Maybe Int -> Maybe Bool -> SqlColDesc

-- | Type of data stored here
colType :: SqlColDesc -> SqlTypeId

-- | The size of a column
colSize :: SqlColDesc -> Maybe Int

-- | The maximum size in octets
colOctetLength :: SqlColDesc -> Maybe Int

-- | Digits to the right of the period
colDecDigits :: SqlColDesc -> Maybe Int

-- | Whether NULL is acceptable
colNullable :: SqlColDesc -> Maybe Bool

-- | 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
--   <a>SqlColDesc</a> for that.
--   
--   These types correspond mainly to those defined by ODBC.
data SqlTypeId

-- | Fixed-width character strings
SqlCharT :: SqlTypeId

-- | Variable-width character strings
SqlVarCharT :: SqlTypeId

-- | Variable-width character strings, max length implementation dependant
SqlLongVarCharT :: SqlTypeId

-- | Fixed-width Unicode strings
SqlWCharT :: SqlTypeId

-- | Variable-width Unicode strings
SqlWVarCharT :: SqlTypeId

-- | Variable-width Unicode strings, max length implementation dependant
SqlWLongVarCharT :: SqlTypeId

-- | Signed exact values
SqlDecimalT :: SqlTypeId

-- | Signed exact integer values
SqlNumericT :: SqlTypeId

-- | 16-bit integer values
SqlSmallIntT :: SqlTypeId

-- | 32-bit integer values
SqlIntegerT :: SqlTypeId
SqlRealT :: SqlTypeId

-- | Signed inexact floating-point values
SqlFloatT :: SqlTypeId

-- | Signed inexact double-precision values
SqlDoubleT :: SqlTypeId

-- | A single bit
SqlBitT :: SqlTypeId

-- | 8-bit integer values
SqlTinyIntT :: SqlTypeId

-- | 64-bit integer values
SqlBigIntT :: SqlTypeId

-- | Fixed-length binary data
SqlBinaryT :: SqlTypeId

-- | Variable-length binary data
SqlVarBinaryT :: SqlTypeId

-- | Variable-length binary data, max length implementation dependant
SqlLongVarBinaryT :: SqlTypeId

-- | A date
SqlDateT :: SqlTypeId

-- | A time
SqlTimeT :: SqlTypeId

-- | Combined date and time
SqlTimestampT :: SqlTypeId

-- | UTC date/time
SqlUTCDateTimeT :: SqlTypeId

-- | UTC time
SqlUTCTimeT :: SqlTypeId

-- | A time or date difference
SqlIntervalT :: SqlInterval -> SqlTypeId

-- | Global unique identifier
SqlGUIDT :: SqlTypeId

-- | A type not represented here; implementation-specific information in
--   the String
SqlUnknownT :: String -> SqlTypeId

-- | The different types of intervals in SQL.
data SqlInterval

-- | Difference in months
SqlIntervalMonthT :: SqlInterval

-- | Difference in years
SqlIntervalYearT :: SqlInterval

-- | Difference in years+months
SqlIntervalYearToMonthT :: SqlInterval

-- | Difference in days
SqlIntervalDayT :: SqlInterval

-- | Difference in hours
SqlIntervalHourT :: SqlInterval

-- | Difference in minutes
SqlIntervalMinuteT :: SqlInterval

-- | Difference in seconds
SqlIntervalSecondT :: SqlInterval

-- | Difference in days+hours
SqlIntervalDayToHourT :: SqlInterval

-- | Difference in days+minutes
SqlIntervalDayToMinuteT :: SqlInterval

-- | Difference in days+seconds
SqlIntervalDayToSecondT :: SqlInterval

-- | Difference in hours+minutes
SqlIntervalHourToMinuteT :: SqlInterval

-- | Difference in hours+seconds
SqlIntervalHourToSecondT :: SqlInterval

-- | Difference in minutes+seconds
SqlIntervalMinuteToSecondT :: SqlInterval
instance Eq SqlInterval
instance Show SqlInterval
instance Read SqlInterval
instance Eq SqlTypeId
instance Show SqlTypeId
instance Read SqlTypeId
instance Eq SqlColDesc
instance Read SqlColDesc
instance Show SqlColDesc
instance Typeable SqlInterval
instance Typeable SqlTypeId
instance Typeable SqlColDesc

module Database.HDBC.Statement
data Statement
Statement :: ([SqlValue] -> IO Integer) -> ([[SqlValue]] -> IO ()) -> IO () -> IO (Maybe [SqlValue]) -> IO [String] -> String -> IO [(String, SqlColDesc)] -> Statement

-- | Execute the prepared statement, passing in the given positional
--   parameters (that should take the place of the question marks in the
--   call to <tt>prepare</tt>).
--   
--   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 :: Statement -> [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 <a>execute</a> on it.
--   
--   Due to optimizations that are possible due to different databases and
--   driver designs, this can often be significantly faster than using
--   <a>execute</a> multiple times since queries need to be compiled only
--   once.
--   
--   This is most useful for non-SELECT statements.
executeMany :: Statement -> [[SqlValue]] -> IO ()

-- | Abort a query in progress -- usually not needed.
finish :: Statement -> IO ()

-- | Fetches one row from the DB. Returns <a>Nothing</a> if there are no
--   more rows. Will automatically call <a>finish</a> when the last row is
--   read.
fetchRow :: Statement -> 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 <a>execute</a> 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
--   <tt>AS</tt> clauses for anything other than simple columns.
--   
--   A simple getColumnNames implementation could simply apply <tt>map
--   fst</tt> to the return value of <a>describeResult</a>.
getColumnNames :: Statement -> IO [String]

-- | The original query that this <a>Statement</a> was prepared with.
originalQuery :: Statement -> String

-- | Obtain information about the columns in the result set. Must be run
--   only after <a>execute</a>. 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 <tt>Database.HDBC.fetchAllRows'</tt>.
--   
--   All results should be converted to lowercase for you before you see
--   them.
--   
--   Please see caveats under <a>getColumnNames</a> for information on the
--   column name field here.
describeResult :: Statement -> 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 :: String -> Int -> String -> SqlError
seState :: SqlError -> String
seNativeError :: SqlError -> Int
seErrorMsg :: SqlError -> String

-- | Conversions to and from <a>SqlValue</a>s and standard Haskell types.
--   
--   Conversions are powerful; for instance, you can call <a>fromSql</a> 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, <a>SqlNull</a> as the input will cause an error
--   to be raised.
--   
--   Here are some notes about conversion:
--   
--   <ul>
--   <li>Fractions of a second are not preserved on time values</li>
--   </ul>
--   
--   See also <a>nToSql</a>, <a>iToSql</a>.
class (Show a) => SqlType a
toSql :: (SqlType a) => a -> SqlValue
fromSql :: (SqlType a) => SqlValue -> a

-- | Converts any Integral type to a <a>SqlValue</a> by using toInteger.
nToSql :: (Integral a) => a -> SqlValue

-- | Convenience function for using numeric literals in your program.
iToSql :: Int -> 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
--   <a>SqlValue</a> type. <a>fromSql</a> can then be used to convert them
--   into whatever type is needed locally in Haskell.
--   
--   Most people will use <a>toSql</a> and <a>fromSql</a> instead of
--   manipulating <a>SqlValue</a>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 -> SqlValue
SqlByteString :: ByteString -> SqlValue
SqlWord32 :: Word32 -> SqlValue
SqlWord64 :: Word64 -> SqlValue
SqlInt32 :: Int32 -> SqlValue
SqlInt64 :: Int64 -> SqlValue
SqlInteger :: Integer -> SqlValue
SqlChar :: Char -> SqlValue
SqlBool :: Bool -> SqlValue
SqlDouble :: Double -> SqlValue
SqlRational :: Rational -> SqlValue

-- | Representation of ClockTime or CalendarTime
SqlEpochTime :: Integer -> SqlValue

-- | Representation of TimeDiff
SqlTimeDiff :: Integer -> SqlValue

-- | NULL in SQL or Nothing in Haskell
SqlNull :: SqlValue
instance Show SqlValue
instance Eq SqlError
instance Show SqlError
instance Read SqlError
instance (SqlType a) => SqlType (Maybe a)
instance SqlType CalendarTime
instance SqlType TimeDiff
instance SqlType ClockTime
instance SqlType Rational
instance SqlType Double
instance SqlType Char
instance SqlType Bool
instance SqlType Integer
instance SqlType Word64
instance SqlType Word32
instance SqlType Int64
instance SqlType Int32
instance SqlType Int
instance SqlType ByteString
instance SqlType String
instance Eq SqlValue
instance Typeable SqlError


-- | Types for HDBC.
--   
--   Please note: this module is intended for authors of database driver
--   libraries only. Authors of applications using HDBC should use
--   <tt>Database.HDBC</tt> exclusively.
--   
--   Written by John Goerzen, jgoerzen@complete.org
module Database.HDBC.Types

-- | Main database handle object.
--   
--   An <a>IConnection</a> 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 <a>disconnect</a>.
--   
--   A call to <a>commit</a> is required to make sure that your changes get
--   committed to the database. In other words, HDBC has <i>no support for
--   autocommit</i>, which we consider an outdated notion.
class IConnection conn
disconnect :: (IConnection conn) => conn -> IO ()
commit :: (IConnection conn) => conn -> IO ()
rollback :: (IConnection conn) => conn -> IO ()
run :: (IConnection conn) => conn -> String -> [SqlValue] -> IO Integer
prepare :: (IConnection conn) => conn -> String -> IO Statement
clone :: (IConnection conn) => conn -> IO conn
hdbcDriverName :: (IConnection conn) => conn -> String
hdbcClientVer :: (IConnection conn) => conn -> String
proxiedClientName :: (IConnection conn) => conn -> String
proxiedClientVer :: (IConnection conn) => conn -> String
dbServerVer :: (IConnection conn) => conn -> String
dbTransactionSupport :: (IConnection conn) => conn -> Bool
getTables :: (IConnection conn) => conn -> IO [String]
describeTable :: (IConnection conn) => conn -> String -> IO [(String, SqlColDesc)]
data Statement
Statement :: ([SqlValue] -> IO Integer) -> ([[SqlValue]] -> IO ()) -> IO () -> IO (Maybe [SqlValue]) -> IO [String] -> String -> IO [(String, SqlColDesc)] -> Statement

-- | Execute the prepared statement, passing in the given positional
--   parameters (that should take the place of the question marks in the
--   call to <tt>prepare</tt>).
--   
--   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 :: Statement -> [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 <a>execute</a> on it.
--   
--   Due to optimizations that are possible due to different databases and
--   driver designs, this can often be significantly faster than using
--   <a>execute</a> multiple times since queries need to be compiled only
--   once.
--   
--   This is most useful for non-SELECT statements.
executeMany :: Statement -> [[SqlValue]] -> IO ()

-- | Abort a query in progress -- usually not needed.
finish :: Statement -> IO ()

-- | Fetches one row from the DB. Returns <a>Nothing</a> if there are no
--   more rows. Will automatically call <a>finish</a> when the last row is
--   read.
fetchRow :: Statement -> 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 <a>execute</a> 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
--   <tt>AS</tt> clauses for anything other than simple columns.
--   
--   A simple getColumnNames implementation could simply apply <tt>map
--   fst</tt> to the return value of <a>describeResult</a>.
getColumnNames :: Statement -> IO [String]

-- | The original query that this <a>Statement</a> was prepared with.
originalQuery :: Statement -> String

-- | Obtain information about the columns in the result set. Must be run
--   only after <a>execute</a>. 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 <tt>Database.HDBC.fetchAllRows'</tt>.
--   
--   All results should be converted to lowercase for you before you see
--   them.
--   
--   Please see caveats under <a>getColumnNames</a> for information on the
--   column name field here.
describeResult :: Statement -> 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 :: String -> Int -> String -> SqlError
seState :: SqlError -> String
seNativeError :: SqlError -> Int
seErrorMsg :: SqlError -> String

-- | Conversions to and from <a>SqlValue</a>s and standard Haskell types.
--   
--   Conversions are powerful; for instance, you can call <a>fromSql</a> 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, <a>SqlNull</a> as the input will cause an error
--   to be raised.
--   
--   Here are some notes about conversion:
--   
--   <ul>
--   <li>Fractions of a second are not preserved on time values</li>
--   </ul>
--   
--   See also <a>nToSql</a>, <a>iToSql</a>.
class (Show a) => SqlType a
toSql :: (SqlType a) => a -> SqlValue
fromSql :: (SqlType a) => SqlValue -> a

-- | Converts any Integral type to a <a>SqlValue</a> by using toInteger.
nToSql :: (Integral a) => a -> SqlValue

-- | Convenience function for using numeric literals in your program.
iToSql :: Int -> 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
--   <a>SqlValue</a> type. <a>fromSql</a> can then be used to convert them
--   into whatever type is needed locally in Haskell.
--   
--   Most people will use <a>toSql</a> and <a>fromSql</a> instead of
--   manipulating <a>SqlValue</a>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 -> SqlValue
SqlByteString :: ByteString -> SqlValue
SqlWord32 :: Word32 -> SqlValue
SqlWord64 :: Word64 -> SqlValue
SqlInt32 :: Int32 -> SqlValue
SqlInt64 :: Int64 -> SqlValue
SqlInteger :: Integer -> SqlValue
SqlChar :: Char -> SqlValue
SqlBool :: Bool -> SqlValue
SqlDouble :: Double -> SqlValue
SqlRational :: Rational -> SqlValue

-- | Representation of ClockTime or CalendarTime
SqlEpochTime :: Integer -> SqlValue

-- | Representation of TimeDiff
SqlTimeDiff :: Integer -> SqlValue

-- | NULL in SQL or Nothing in Haskell
SqlNull :: SqlValue

-- | 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:
--   
--   <pre>
--   let wrapped = ConnWrapper iconn
--   </pre>
--   
--   You can then use this directly, since a ConnWrapper is also an
--   <a>IConnection</a>. However, you will not be able to use private
--   database functions on it.
--   
--   Or, you can use <a>withWConn</a>.
data ConnWrapper
ConnWrapper :: conn -> ConnWrapper

-- | Unwrap a <a>ConnWrapper</a> and pass the embedded <a>IConnection</a>
--   to a function. Example:
--   
--   <pre>
--   withWConn wrapped run $ "SELECT * from foo where bar = 1" []
--   </pre>
withWConn :: ConnWrapper -> (forall conn. (IConnection conn) => conn -> b) -> b
instance IConnection ConnWrapper


-- | 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
--   <tt>Database.HDBC</tt> exclusively.
--   
--   Written by John Goerzen, jgoerzen@complete.org
module Database.HDBC.DriverUtils
type ChildList = MVar [Weak Statement]

-- | Close all children. Intended to be called by the <a>disconnect</a>
--   function in <tt>Connection</tt>.
--   
--   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.
closeAllChildren :: ChildList -> 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.
addChild :: ChildList -> Statement -> IO ()


-- | Welcome to HDBC, the Haskell Database Connectivity library.
--   
--   Written by John Goerzen, jgoerzen@complete.org
module Database.HDBC

-- | Conversions to and from <a>SqlValue</a>s and standard Haskell types.
--   
--   Conversions are powerful; for instance, you can call <a>fromSql</a> 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, <a>SqlNull</a> as the input will cause an error
--   to be raised.
--   
--   Here are some notes about conversion:
--   
--   <ul>
--   <li>Fractions of a second are not preserved on time values</li>
--   </ul>
--   
--   See also <a>nToSql</a>, <a>iToSql</a>.
class (Show a) => SqlType a
toSql :: (SqlType a) => a -> SqlValue
fromSql :: (SqlType a) => SqlValue -> a

-- | Converts any Integral type to a <a>SqlValue</a> by using toInteger.
nToSql :: (Integral a) => a -> SqlValue

-- | Convenience function for using numeric literals in your program.
iToSql :: Int -> 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
--   <a>SqlValue</a> type. <a>fromSql</a> can then be used to convert them
--   into whatever type is needed locally in Haskell.
--   
--   Most people will use <a>toSql</a> and <a>fromSql</a> instead of
--   manipulating <a>SqlValue</a>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 -> SqlValue
SqlByteString :: ByteString -> SqlValue
SqlWord32 :: Word32 -> SqlValue
SqlWord64 :: Word64 -> SqlValue
SqlInt32 :: Int32 -> SqlValue
SqlInt64 :: Int64 -> SqlValue
SqlInteger :: Integer -> SqlValue
SqlChar :: Char -> SqlValue
SqlBool :: Bool -> SqlValue
SqlDouble :: Double -> SqlValue
SqlRational :: Rational -> SqlValue

-- | Representation of ClockTime or CalendarTime
SqlEpochTime :: Integer -> SqlValue

-- | Representation of TimeDiff
SqlTimeDiff :: Integer -> SqlValue

-- | NULL in SQL or Nothing in Haskell
SqlNull :: SqlValue

-- | Main database handle object.
--   
--   An <a>IConnection</a> 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 <a>disconnect</a>.
--   
--   A call to <a>commit</a> is required to make sure that your changes get
--   committed to the database. In other words, HDBC has <i>no support for
--   autocommit</i>, which we consider an outdated notion.
class IConnection conn
disconnect :: (IConnection conn) => conn -> IO ()
commit :: (IConnection conn) => conn -> IO ()
rollback :: (IConnection conn) => conn -> IO ()
run :: (IConnection conn) => conn -> String -> [SqlValue] -> IO Integer
prepare :: (IConnection conn) => conn -> String -> IO Statement
clone :: (IConnection conn) => conn -> IO conn
hdbcDriverName :: (IConnection conn) => conn -> String
hdbcClientVer :: (IConnection conn) => conn -> String
proxiedClientName :: (IConnection conn) => conn -> String
proxiedClientVer :: (IConnection conn) => conn -> String
dbServerVer :: (IConnection conn) => conn -> String
dbTransactionSupport :: (IConnection conn) => conn -> Bool
getTables :: (IConnection conn) => conn -> IO [String]
describeTable :: (IConnection conn) => conn -> String -> IO [(String, SqlColDesc)]

-- | 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:
--   
--   <pre>
--   let wrapped = ConnWrapper iconn
--   </pre>
--   
--   You can then use this directly, since a ConnWrapper is also an
--   <a>IConnection</a>. However, you will not be able to use private
--   database functions on it.
--   
--   Or, you can use <a>withWConn</a>.
data ConnWrapper
ConnWrapper :: conn -> ConnWrapper

-- | Unwrap a <a>ConnWrapper</a> and pass the embedded <a>IConnection</a>
--   to a function. Example:
--   
--   <pre>
--   withWConn wrapped run $ "SELECT * from foo where bar = 1" []
--   </pre>
withWConn :: ConnWrapper -> (forall conn. (IConnection conn) => conn -> b) -> b

-- | Like <a>run</a>, but take a list of Maybe Strings instead of
--   <a>SqlValue</a>s.
sRun :: (IConnection conn) => conn -> String -> [Maybe String] -> IO Integer

-- | Strict version of <a>quickQuery</a>.
quickQuery' :: (IConnection conn) => conn -> String -> [SqlValue] -> IO [[SqlValue]]

-- | A quick way to do a query. Similar to preparing, executing, and then
--   calling <a>fetchAllRows</a> on a statement. See also
--   <a>quickQuery'</a>
quickQuery :: (IConnection conn) => conn -> String -> [SqlValue] -> IO [[SqlValue]]

-- | Execute some code. If any uncaught exception occurs, run
--   <a>rollback</a> and re-raise it. Otherwise, run <a>commit</a> and
--   return.
--   
--   This function, therefore, encapsulates the logical property that a
--   transaction is all about: all or nothing.
--   
--   The <a>IConnection</a> object passed in is passed directly to the
--   specified function as a convenience.
--   
--   This function traps <i>all</i> 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 <tt>Database.HDBC.commit</tt> or
--   <tt>Database.HDBC.rollback</tt> 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 <a>rollback</a>, 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.
withTransaction :: (IConnection conn) => conn -> (conn -> IO a) -> IO a
data Statement

-- | Execute the prepared statement, passing in the given positional
--   parameters (that should take the place of the question marks in the
--   call to <tt>prepare</tt>).
--   
--   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 :: Statement -> [SqlValue] -> IO Integer

-- | Like <a>execute</a>, but take a list of Maybe Strings instead of
--   <a>SqlValue</a>s.
sExecute :: Statement -> [Maybe String] -> IO Integer

-- | Execute the query with many rows. The return value is the return value
--   from the final row as if you had called <a>execute</a> on it.
--   
--   Due to optimizations that are possible due to different databases and
--   driver designs, this can often be significantly faster than using
--   <a>execute</a> multiple times since queries need to be compiled only
--   once.
--   
--   This is most useful for non-SELECT statements.
executeMany :: Statement -> [[SqlValue]] -> IO ()

-- | Like <a>executeMany</a>, but take a list of Maybe Strings instead of
--   <a>SqlValue</a>s.
sExecuteMany :: Statement -> [[Maybe String]] -> IO ()

-- | Fetches one row from the DB. Returns <a>Nothing</a> if there are no
--   more rows. Will automatically call <a>finish</a> when the last row is
--   read.
fetchRow :: Statement -> IO (Maybe [SqlValue])

-- | Like <a>fetchRow</a>, 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 <a>getColumnNames</a>. Please heed the warnings there.
--   Additionally, results are undefined if multiple columns are returned
--   with identical names.
fetchRowAL :: Statement -> IO (Maybe [(String, SqlValue)])

-- | Similar to <a>fetchRowAL</a>, but return a Map instead of an
--   association list.
fetchRowMap :: Statement -> IO (Maybe (Map String SqlValue))

-- | Like <a>fetchRow</a>, but return a list of Maybe Strings instead of
--   <a>SqlValue</a>s.
sFetchRow :: Statement -> IO (Maybe [Maybe String])

-- | Lazily fetch all rows from an executed <a>Statement</a>.
--   
--   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 <a>Statement</a> will be
--   <a>finish</a>ed.
--   
--   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 <a>finish</a> 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.
--   
--   Use <a>fetchAllRows'</a> if you need something that is strict, without
--   all these caveats.
fetchAllRows :: Statement -> IO [[SqlValue]]

-- | Strict version of <a>fetchAllRows</a>. Does not have the side-effects
--   of <a>fetchAllRows</a>, but forces the entire result set to be
--   buffered in memory.
fetchAllRows' :: Statement -> IO [[SqlValue]]

-- | Like <a>fetchAllRows</a>, but instead of returning a list for each
--   row, return an association list for each row, from column name to
--   value.
--   
--   See <a>fetchRowAL</a> for more details.
fetchAllRowsAL :: Statement -> IO [[(String, SqlValue)]]

-- | Strict version of <a>fetchAllRowsAL</a>
fetchAllRowsAL' :: Statement -> IO [[(String, SqlValue)]]

-- | Like <a>fetchAllRowsAL</a>, but return a list of Maps instead of a
--   list of association lists.
fetchAllRowsMap :: Statement -> IO [Map String SqlValue]

-- | Strict version of <a>fetchAllRowsMap</a>
fetchAllRowsMap' :: Statement -> IO [Map String SqlValue]

-- | Like <a>fetchAllRows</a>, but return Maybe Strings instead of
--   <a>SqlValue</a>s.
sFetchAllRows :: Statement -> IO [[Maybe String]]

-- | Strict version of <a>sFetchAllRows</a>.
sFetchAllRows' :: Statement -> IO [[Maybe 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 <a>execute</a> 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
--   <tt>AS</tt> clauses for anything other than simple columns.
--   
--   A simple getColumnNames implementation could simply apply <tt>map
--   fst</tt> to the return value of <a>describeResult</a>.
getColumnNames :: Statement -> IO [String]

-- | Obtain information about the columns in the result set. Must be run
--   only after <a>execute</a>. 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 <tt>Database.HDBC.fetchAllRows'</tt>.
--   
--   All results should be converted to lowercase for you before you see
--   them.
--   
--   Please see caveats under <a>getColumnNames</a> for information on the
--   column name field here.
describeResult :: Statement -> IO [(String, SqlColDesc)]

-- | Abort a query in progress -- usually not needed.
finish :: Statement -> IO ()

-- | The original query that this <a>Statement</a> was prepared with.
originalQuery :: Statement -> String

-- | 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 :: String -> Int -> String -> SqlError
seState :: SqlError -> String
seNativeError :: SqlError -> Int
seErrorMsg :: SqlError -> String

-- | Execute the given IO action.
--   
--   If it raises a <a>SqlError</a>, then execute the supplied handler and
--   return its return value. Otherwise, proceed as normal.
catchSql :: IO a -> (SqlError -> IO a) -> IO a

-- | Like <a>catchSql</a>, with the order of arguments reversed.
handleSql :: (SqlError -> IO a) -> IO a -> IO a

-- | Given an Exception, return Just SqlError if it was an SqlError, or
--   Nothing otherwise. Useful with functions like catchJust.
sqlExceptions :: Exception -> Maybe SqlError

-- | Catches <a>SqlError</a>s, 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.
handleSqlError :: IO a -> IO a