SQL.CLI.Utils

Documentation

data SQLConfig

configuration values dependent on the actual CLI implementation

Constructors

SQLConfig

Fields

• sql_cli_flds_table_cat :: SQLSMALLINT

  position of TABLE_CAT column in the resultset returned by Columns API call

• sql_cli_flds_table_schem :: SQLSMALLINT

  position of TABLE_SCHEM column in the resultset returned by Columns API call

• sql_cli_flds_table_name :: SQLSMALLINT

  position of TABLE_NAME column in the resultset returned by Columns API call

• sql_cli_flds_column_name :: SQLSMALLINT

  position of COLUMN_NAME column in the resultset returned by Columns API call

• sql_cli_flds_data_type :: SQLSMALLINT

  position of DATA_TYPE column in the resultset returned by Columns API call

• sql_cli_flds_type_name :: SQLSMALLINT

  position of TYPE_NAME column in the resultset returned by Columns API call

• sql_cli_flds_column_size :: SQLSMALLINT

  position of COLUMN_SIZE column in the resultset returned by Columns API call

• sql_cli_flds_buffer_length :: SQLSMALLINT

  position of BUFFER_LENGTH column in the resultset returned by Columns API call

• sql_cli_flds_decimal_digits :: SQLSMALLINT

  position of DECIMAL_DIGITS column in the resultset returned by Columns API call

• sql_cli_flds_num_prec_radix :: SQLSMALLINT

  position of NUM_PREC_RADIX column in the resultset returned by Columns API call

• sql_cli_flds_nullable :: SQLSMALLINT

  position of NULLABLE column in the resultset returned by Columns API call

• sql_cli_flds_remarks :: SQLSMALLINT

  position of REMARKS column in the resultset returned by Columns API call

• sql_cli_flds_column_def :: SQLSMALLINT

  position of COLUMN_DEF column in the resultset returned by Columns API call

• sql_cli_flds_datetime_code :: SQLSMALLINT

  position of DATETIME_CODE column in the resultset returned by Columns API call

• sql_cli_flds_char_octet_length :: SQLSMALLINT

  position of CHAR_OCTET_LENGTH column in the resultset returned by Columns API call

• sql_cli_flds_ordinal_position :: SQLSMALLINT

  position of ORDINAL_POSITION column in the resultset returned by Columns API call

• sql_cli_flds_is_nullable :: SQLSMALLINT

  position of IS_NULLABLE column in the resultset returned by Columns API call

data ColumnInfo

information about column in the database; the meaning of fields is detailed in the SQL CLI specification in the documenation of Columns API call

Constructors

ColumnInfo

Fields

• ci_TableCat :: Maybe String
• ci_TableSchem :: String
• ci_TableName :: String
• ci_ColumnName :: String
• ci_DataType :: SQLSMALLINT
• ci_TypeName :: String
• ci_ColumnSize :: Maybe SQLINTEGER
• ci_BufferLength :: Maybe SQLINTEGER
• ci_DecimalDigits :: Maybe SQLSMALLINT
• ci_NumPrecRadix :: Maybe SQLSMALLINT
• ci_Nullable :: SQLSMALLINT
• ci_Remarks :: Maybe String
• ci_ColumnDef :: Maybe String
• ci_DatetimeCode :: Maybe SQLINTEGER
• ci_CharOctetLength :: Maybe SQLINTEGER
• ci_OrdinalPosition :: SQLINTEGER
• ci_IsNullable :: Maybe String

Instances

Show ColumnInfo

Methods

showsPrec :: Int -> ColumnInfo -> ShowS

show :: ColumnInfo -> String

showList :: [ColumnInfo] -> ShowS

collectColumnsInfo :: (MonadIO m, MonadFail m) => SQLHDBC -> String -> ReaderT SQLConfig m [ColumnInfo]

Read columns information for a given table on a database connection. It returns a ReaderT value that will get implementation dependent fieled numbers in the result set returned by Columns API call from a SQLConfig value.

tableExists :: (MonadIO m, MonadFail m) => SQLHDBC -> String -> m Bool

Checks if a table exists on the current connection.

data ConciseColInfo

concise information about a column of a result set, mapping the result of SQL CLI API call DescribeCol

Constructors

ConciseColInfo

Fields

• cci_ColumnName :: String
• cci_DataType :: SQLSMALLINT
• cci_ColumnSize :: SQLINTEGER
• cci_DecimalDigits :: SQLSMALLINT
• cci_Nullable :: Bool

describeCol :: (MonadIO m, MonadFail m) => SQLHSTMT -> SQLSMALLINT -> m ConciseColInfo

wrapper for DescribeCol SQL CLI API call

columns :: (MonadIO m, MonadFail m) => SQLHSTMT -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> m ()

wrapper for SQL CLI Columns API call

tables :: (MonadIO m, MonadFail m) => SQLHSTMT -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> m ()

wrapper for SQL CLI Tables API call

forAllRecords :: (MonadIO m, MonadFail m) => SQLHSTMT -> (a -> m a) -> a -> m a

applies a function through all the records in a statment, passing an accumulator value and combining the actions returned by the function

getData :: (MonadIO m, MonadFail m) => SQLHSTMT -> SQLSMALLINT -> SQLSMALLINT -> SQLPOINTER -> SQLINTEGER -> Ptr SQLINTEGER -> m Bool

Read data from a column and checks the diagnostics, returning a True or False value inside a monadic action. It returns True if more data is available for read, and False otherwise. It fails in MaybeT IO monad if an error occured. It displays the diagnostics on the error on the standard error.

getDataAndRun :: (MonadIO m, MonadFail m) => SQLHSTMT -> SQLSMALLINT -> SQLSMALLINT -> SQLPOINTER -> SQLINTEGER -> Ptr SQLINTEGER -> m a -> m a -> m a

Read data available in a column of a fetched database record inside a monadic. It fails if an error occurs, displaying the diagnostics on the standard error. It receives 2 monadic actions parameters:

• more
• end

It executes the more action if there is more data available and it executes the end action if all data in the column has been read.

fetch :: (MonadIO m, MonadFail m) => SQLHSTMT -> m Bool

Create a monadic action to fetch the next record in an executed statement producing True if there are more records available or False if all the records have been read.

If an error occurs, the monadic action fails, displaying the error diagnostics on the standard error.

fetchAndRun :: (MonadIO m, MonadFail m) => SQLHSTMT -> m a -> m a -> m a

Create a monadic action to fetch the next record in an excecuted statement. It, then, executes one of the 2 actions received as parameters -- more and end -- depending on if there are more records available or if the last record has been fetched.

If an error occrus, the monadic action fails, displaying error diagnostics on the standard error.

bindSmallIntCol

Arguments

:: (MonadIO m, MonadFail m)

=> SQLHSTMT

statement handle

-> SQLSMALLINT

column number (starting with 1)

-> Ptr SQLSMALLINT

buffer to receive the value

-> Ptr SQLINTEGER

buffer to receive the indicator or length; it can be null

-> m ()

helper function to bind a SMALLINT column

bindIntegerCol

Arguments

:: (MonadIO m, MonadFail m)

=> SQLHSTMT

statement handle

-> SQLSMALLINT

column number (starting with 1)

-> Ptr SQLINTEGER

buffer to receive the value

-> Ptr SQLINTEGER

buffer to receive the indicator or length; it can be null

-> m ()

helper function to bind an INTEGER column

bindVarcharCol

Arguments

:: (MonadIO m, MonadFail m)

=> SQLHSTMT

statement handle

-> SQLSMALLINT

column number (starting with 1)

-> CString

buffer to receive the null terminated text data

-> SQLINTEGER

buffer length in bytes, including the null terminating character

-> Ptr SQLINTEGER

pointer to indicator or length; it can be null

-> m ()

helper function to bind a VARCHAR column. The buffer length parameter must include the NULL terminating character of the CString.

bindCol :: (MonadIO m, MonadFail m) => SQLHSTMT -> SQLSMALLINT -> SQLSMALLINT -> SQLPOINTER -> SQLINTEGER -> Ptr SQLINTEGER -> m ()

wrapper for BindCol SQL CLI API call; if an error occurs the computation is stopped and diagnostics are displayed on the standard error

execDirect :: (MonadIO m, MonadFail m) => SQLHSTMT -> String -> m ()

wrapper for SQL CLI ExecDirect API call; if an error occurs, the computation exits displaying diagnostics on the standard error

connect :: (MonadIO m, MonadFail m) => SQLHENV -> String -> String -> String -> m SQLHDBC

utility function that allocates a database connection handle and connects to the database.

On success, the computation returns the handle to the database conncection.

On error, the computation exits, displaying diagnostics on the standard error.

disconnect :: SQLHDBC -> IO ()

wrapper for SQL CLI Disconnect API call; displays diagnostics on the standard error.

allocHandle :: (MonadIO m, MonadFail m) => SQLSMALLINT -> SQLINTEGER -> m SQLINTEGER

wrapper to SQL CLI AllocHandle API call; it displays diagnostics info on the standard error and fails if the handle could not be allocated

freeHandle :: SQLSMALLINT -> SQLINTEGER -> IO ()

wrapper for SQL CLI FreeHandle API call; it displays diagnostics on the standard error; it does not fail

displayDiagInfo :: SQLSMALLINT -> SQLINTEGER -> IO ()

create an IO action that displays diagnostic records for a given handle on the standard error; this action will not fail

displayDiagInfo' :: (MonadIO m, MonadFail m) => SQLSMALLINT -> SQLINTEGER -> m ()

create a monadic action to display the diagnostic records for a given handle on the standard error; it fails if an error occurs while reading diagnostic records.

getCountOfDiagRecs :: (MonadIO m, MonadFail m) => SQLSMALLINT -> SQLINTEGER -> m Int

create a monadic action to read the number of the diagnostic records for a given handle; it fails if an error occurs and it displays diagnostics on standard error

data DiagRecord

information in a diagnostic record

Constructors

DiagRecord

Fields

• sqlstate :: String
• nativeError :: SQLINTEGER
• messageText :: String

getDiagRec :: (MonadIO m, MonadFail m) => SQLSMALLINT -> SQLINTEGER -> SQLSMALLINT -> m DiagRecord

wrapper for SQL CLI GetDiagRec API call; the computation fails if an error occurs and it displays diagnostics on standard error

withMaybeCStringLen :: Maybe String -> (CStringLen -> IO a) -> IO a

helper function to allocate a CStringLen; it calls the function received as parameter with the address of the allocated string or with a null pointer if no string was received as input (i.e. Nothing)

peekMaybeCol :: Storable a => Ptr a -> Ptr SQLINTEGER -> IO (Maybe a)

helper function to read a nullable column; returns Nothing if the column is null

peekMaybeTextCol :: CString -> Ptr SQLINTEGER -> IO (Maybe String)

helper function to read a nullable text column; returns Nothing if the column is null