ODBC Guide

SQLAPI++ allows to seamlessly work with a variety of SQL database servers. It provides unified API to access any database, keeping your code portable. But each server has some specific features which a developer has to know in order to leverage server's unique features and avoid potential errors.

For complete information on using SQLAPI++ check out Getting Started and Documentation. This guide covers specific information related to working with ODBC server using SQLAPI++ library in the following areas:

• Connecting to a database
• Transaction isolation levels
• Working with Long or Lob (CLob, BLob) data
• Returning output parameters
• Cancelling queries
• Connection, command, parameter and field options
• Using native API
• Getting native connection related handles
• Getting native command related handles
• Error handling

Connecting to a database

To connect to a database you need to initialize a connection object. A connection object is represented by SAConnection class.

After the connection is created you need to call SAConnection::Connect method to establish connection with ODBC server:

void Connect(
    const SAString &sDBString,
    const SAString &sUserID, 
    const SAString &sPassword, 
    SAClient_t eSAClient = SA_Client_NotSpecified);

Parameters

sDBString

Any valid ODBC connection string

sUserID

A string containing a user name to use when establishing the connection.

sPassword

A string containing a password to use when establishing the connection.

eSAClient

• SA_ODBC_Client – ODBC client
• SA_Client_NotSpecified – used by default if eSAClient parameter is omitted. You can use this default value only if you have SAConnection::setAPI method with SAPI object initialized with SA_ODBC_Client constant before

For more details see Getting Started - Connect to Database, SAConnection object, SAConnection::Connect.

Transaction isolation levels

SQL-92 defines four isolation levels, all of which are supported by SQLAPI++:

• Read uncommitted (the lowest level where transactions are isolated just enough to ensure that physically corrupt data is not read)
• Read committed
• Repeatable read
• Serializable (the highest level, where transactions are completely isolated from one another)

SQLAPI++ maps different isolation levels on ODBC in the following way:

In addition to the SQL-92 levels, if you specify 'snapshot' isolation level, it will be mapped as: SA_Snapshot → SQL_TXN_SERIALIZABLE.

For more details see SAConnection::setIsolationLevel.

Working with Long or Lob (CLob, BLob) data

When fetching data SQLAPI++ detects data types of the columns in the result set and maps those types to internal library types. The mapping determines which native APIs the library will use for fetching LOB data.

The table below shows how SQLAPI++ maps ODBC server data types to Long/Lob library types:

When binding input data from your program the reverse mapping is taking place. The SQLAPI++ data type you use for input markers determines what native API program types will be used for sending Long/Lob data to the server.

For additional information see Getting Started - Handle Long/CLob/BLob.

Returning output parameters

In ODBC processing output parameters depends on a driver.

If DBMS supports returning output parameters then SQLAPI++ stores the returned values of output parameters in the SAParam objects bound to those parameters. On some servers these returned values are not guaranteed to be available until all results returned by the procedure have been fetched (using SACommand::FetchNext method).

See ODBC driver documentation on output parameters availability on different drivers/servers.

SQLAPI++ Library automatically creates SAParam object to represent function return value. You can refer to this SAParam object using SQLAPI++ predefined name "RETURN_VALUE".

For additional information see SACommand::Execute, SAParam object, Getting Started - Get Output Parameters.

Cancelling queries

Using SACommand::Cancel method you can cancel the following types of processing on a statement:

• function running asynchronously on the statement
• function running on the statement on another thread

SQLAPI++ calls SQLCancel function to cancel a query. To get more details see SQLCancel function description in native ODBC documentation.

For additional information see SACommand::Cancel.

Connection, command, parameter and field options

Specific options applicable to ODBC:

For additional information see SAOptions::setOption.

Using native ODBC API

You can call client specific API functions which are not directly supported by SQLAPI++ library. SAConnection::NativeAPI method returns a pointer to the set of native API functions available for ODBC. To use the database API directly you have to downcast this IsaAPI pointer to the appropriate type and use its implementation-specific members. The following example shows what type cast you have to make and what additional header file you have to include to work with ODBC API. Note that using appropriate type casting depends on an API (that generally mean that you have to explicitly check client version before casting, see SAConnection::ClientVersion method).

To use native API you need to add ODBC specific #include and cast the result of SAConnection::NativeAPI to class odbcAPI:

#include "odbcAPI.h"

IsaAPI *pApi = con.NativeAPI();
odbcAPI *pNativeAPI = (odbcAPI *)pApi;

To get more information about ODBC API functions see ODBC documentation.

For additional information see SAConnection::NativeAPI.

Getting native ODBC connection related handles

You have to use native API handles when you want to call specific ODBC API functions which are not directly supported by the library. API functions usually need to receive one or more active handles as parameters. SAConnection::NativeHandles method returns a pointer to the set of native API connection related handles. To use API handles directly you have to downcast saConnectionHandles pointer to the appropriate type and use its implementation-specific members.

To access native connection handles you need to add ODBC specific #include and cast the result to class odbcConnectionHandles:

#include "odbcAPI.h"

saConnectionHandles *pHandles = con.NativeHandles();
odbcConnectionHandles *pNativeHandles = (odbcConnectionHandles*)pHandles;

To get more information about ODBC API functions and handles see ODBC specific documentation.

For additional information see SAConnection::NativeHandles.

Getting native ODBC command related handles

You have to use native API handles when you want to call specific ODBC API functions which are not directly supported by the library. API functions usually need to receive one or more active handles as parameters. SACommand::NativeHandles method returns a pointer to the set of native API command related handles. To use API handles directly you have to downcast saCommandHandles pointer to the appropriate type and use its implementation-specific members.

To access native command handles you need to add ODBC specific #include and cast the result to class odbcCommandHandles:

#include "odbcAPI.h"

saCommandHandles *pHandles = cmd.NativeHandles();
odbcCommandHandles *pNativeHandles = (odbcCommandHandles*)pHandles;

To get more information about ODBC API functions and handles see ODBC specific documentation.

For additional information see SACommand::NativeHandles.

Error handling

When an error occurs when executing a SQL statement SQLAPI++ library throws an exception of type SAException and SAException::ErrPos method returns error position in the SQL statement.

In ODBC server SAException::ErrPos method returns -1 because ODBC does not support this function.

For additional information see Getting Started - Error Handling, SAException object.