Documentation

convert an implementation type to a SQL/CLI known type; checks if the type identifier is a SQL/CLI type; if not returns sql_varchar

configuration values dependent on the actual CLI implementation

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

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.

Implements the logic of collectColumnsInfo getting the handle to the statement that was used to call sqlcolumns on

Checks if a table exists on the current connection.

wrapper to SQL/CLI function EndTran; it creates a monadic action to call the foreign API function and to log diagnostics on the standard output; it fails if the API call fails

wrapper for SQL/CLI function SetConnectAttr; it creates a monadic action that calls the foreign API function and logs diagnostics on standard error; it fails if the API call fails

wrapper for SQL/CLI function SetDescField; it creates a monadic action that calls the API function, logs diagnostic on standard output and fails if the API call fails

wrapper for SQL/CLI function GetDescField; it creates a monadic action that calls the API function, logs disgnostic on standard output and fails if the API call fails

wrapper for SQL/CLI function SetDescRec; it gets the same parameters as the function described in the API and creates a monadic action that fails if the API call fails and logs the diagnostics to standard error

wrapper for SQL/CLI function GetDescRec; it gets the same parameters as the function described in the API and creates a monadic action that fails if the API call fails and logs the diagnostics to standard error

wrapper for SQL/CLI function NumResultCols; it fails if the API call fails and it displays diagnostic information on the standard error

helper function to get the value of a Storable statement attribute

wrapper for SQL/CLI function GetStmtAttr; it displays diagnostic info on the standard error and it fails if the call SQL/CLI call fails

wrapper for SQL/CLI function, BindParam; it displayes diagnostics on standard error

wrapper for PutData SQL/CLI api call; it displays diagnostics on standard error

wrapper for ParamData SQL/CLI API call; it gets a statement handle and a function that knows how to supply parameter data; this function gets the value DATA_PTR field of the record in the application parameter descriptor that relates to the dynamic parameter for which the implementation requires information.

The successful return of this call means that all parameter data has been supplied and the sql statement has been executed.

wrapper for Prepare SQL/CLI API call

wrapper for Execute SQL/CLI API call; it receives ab handle to a prepared statement and a monadic action that should provide dynamic arguments data using calls to sqlputdata and sqlparamdata; this action will be used in the case sqlexecute returns sql_need_data, that is, if the prepared statement specifies some dynamic parameters that are not described in the application parameter descriptor (for example, by calling sqlbindparam for that parameter); the action must provide the data for parameters in the order the parameters appear in the sql statement and call sqlparamdata after each parameter data has been provided

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

wrapper for DescribeCol SQL CLI API call

wrapper for SQL CLI Columns API call

wrapper for SQL CLI Tables API call

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

applies a function through all the records in a statment, passing an accumulator value and combining the actions returned by the function; if all records have been successfully fetched, the second function is called; if an error occures, the third function is called, with the error message

exhaust all data of a column extracting all data chunks with GetData SQL/CLI call, and calling a function after extraction of each chunk passing it an accumulator value; the function should construct a monadic action that will deal with the extracted data chunk; in the end, these actions are combined in the monadic value returned by the forAllData

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.

Read data available in a column of a fetched database record inside a monadic action. 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.

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.

Create a monadic action to fetch the next record in an excecuted statement. It, then, executes one of the 2 actions received as parameters. If sqlfetch returns a success code, it executes the first action, else, if sql_no_data is received as result (there were no more records to fetch), it executes the second action.

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

Create a monadic action to fetch the next record in an excecuted statement. It, then, executes one of the 3 actions received as parameters depending on the result of calling sqlfetch function.

If sqlfetch call returns a success code, then the first action is called, that should process the fetched record.

If sqlfetch returns sql_no_data, meaning there are no more records to fetch, the second action is called that should terminate the data fetching on this statement.

If sqlfetch returns an error, the third action is executed that should process the error condition, passing it the fail error message.

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

helper function to bind a SMALLINT column

helper function to bind an INTEGER column

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

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

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

It gets 3 parameters: a handle statement, a sql string and a feed data action; if sqlexecdirect returns sql_need_data, it executes the feed data action.

The feed data action is responsible with supplying the needed data for dynamic parameters by calling sqlputdata and sqlparamdata. See more details on SQL/CLI specification for ExecDirect, PutData and ParamData API calls.

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.

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

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

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

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

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.

display a diagnostic record on standard error

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

information in a diagnostic record

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

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)

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

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