hsql-1.8.1: Simple library for database access from Haskell.

Database.HSQL.Types

Description

Basic type class & type definitions for DB interfacing.

Synopsis

Documentation

type FieldDef = (String, SqlType, Bool)Source

data SqlType Source

Differentiation of data types used in DBs.

Constructors

SqlInteger 
SqlBigInt 
SqlSmallInt 
SqlTinyInt 
SqlMedInt 
SqlDecimal Int Int 
SqlNumeric Int Int 
SqlReal 
SqlDouble 
SqlFloat 
SqlMoney 
SqlChar Int 
SqlVarChar Int 
SqlLongVarChar Int 
SqlText 
SqlWChar Int 
SqlWVarChar Int 
SqlWLongVarChar Int 
SqlDate 
SqlTime 
SqlTimeTZ 
SqlAbsTime 
SqlRelTime 
SqlTimeInterval 
SqlAbsTimeInterval 
SqlTimeStamp 
SqlDateTime 
SqlDateTimeTZ 
SqlYear 
SqlBit 
SqlENUM 
SqlPoint 
SqlLSeg 
SqlPath 
SqlBox 
SqlPolygon 
SqlLine 
SqlCircle 
SqlINetAddr 
SqlCIDRAddr 
SqlMacAddr 
SqlBinary Int 
SqlVarBinary Int 
SqlLongVarBinary Int 
SqlSET 
SqlBLOB 
SqlUnknown Int

HSQL returns SqlUnknown tp for all columns for which it cannot determine the right type. The tp here is the internal type code returned from the backend library

Instances

data SqlError Source

Constructors

SqlError 

Fields

seState :: String
 
seNativeError :: Int
 
seErrorMsg :: String
 
SqlNoData 
SqlInvalidHandle 
SqlStillExecuting 
SqlNeedData 
SqlBadTypeCast 

Fields

seFieldName :: String
 
seFieldType :: SqlType
 
SqlFetchNull 

Fields

seFieldName :: String
 
SqlUnknownField 

Fields

seFieldName :: String
 
SqlUnsupportedOperation 
SqlClosedHandle 

Instances

sqlErrorTc :: TyConSource

data Connection Source

A Connection type represents a connection to a database, through which you can operate on the it. In order to create the connection you need to use the connect function from the module for your prefered backend.

Constructors

Connection 

Fields

connDisconnect :: IO ()

disconnect action

connExecute :: String -> IO ()

query execution action (without return value)

connQuery :: String -> IO Statement

query action with return value

connTables :: IO [String]

retrieval of the names of the tables in reach

connDescribe :: String -> IO [FieldDef]

retrieval of the field defs of a table

connBeginTransaction :: IO ()

begin of a transaction

connCommitTransaction :: IO ()

commit of a pending transaction

connRollbackTransaction :: IO ()

rollback of a pending transaction

connClosed :: MVar Bool

closing state of the connection

data Statement Source

The Statement type represents a result from the execution of given SQL query.

Constructors

Statement 

Fields

stmtConn :: Connection

field descriptors

stmtClose :: IO ()

closing action

stmtFetch :: IO Bool

incrementation of the row pointer and indication whether this is still in range of available rows

stmtGetCol :: forall a. Int -> FieldDef -> (FieldDef -> CString -> Int -> IO a) -> IO a

extraction of a field from the current result row, with

  • a column index
  • a column field definition
  • a generic field extraction function, specifiable by a field definition, a C string and its length
stmtFields :: [FieldDef]

field descriptors

stmtClosed :: MVar Bool

closing state of the statement

class SqlBind a whereSource

Methods

toSqlValue :: a -> StringSource

fromSqlValue :: SqlType -> String -> Maybe aSource

fromSqlCStringLen :: FieldDef -> CString -> Int -> IO aSource

This allows for faster conversion for eq. integral numeric types, etc. Default version uses fromSqlValue.

Instances