Main | License | Installation | FAQ | Screenshots | Contact | Links | Sf.net | Freshmeat.net | KDE-Apps.org

ODBCDatabase Class Reference

#include <odbcDatabase.hpp>

Inheritance diagram for ODBCDatabase:

[legend]

Public Member Functions
	ODBCDatabase (const std::string &databaseName, const std::string &userName, const std::string &passWord) throw (Error)
virtual	~ODBCDatabase (void)
	Destructor.
virtual StatementPtr	execQuery (const std::string &query) throw (Error)
Protected Attributes
SQLHENV	odbcEnvironment
	ODBC environment handle.
SQLHDBC	connection
	Connection handle.

---

Detailed Description

Class for connecting to ODBC-database.

Deprecated:

{The ODBC classes are not in use at the moment}

Date:

Thu Mar 03 2005

Author:

Jan Wedekind (wedesoft@users.sourceforge.net)

Definition at line 27 of file odbcDatabase.hpp.

---

Constructor & Destructor Documentation

ODBCDatabase::ODBCDatabase	(	const std::string &	databaseName,
		const std::string &	userName,
		const std::string &	passWord
	)			throw (Error)

Constructor establishing connection to the data source.

Parameters:

	databaseName	Name of unixODBC's data source.
	userName	Name of database user.
	passWord	Password of user. The password will be passed to the SQLConnect command.

Definition at line 24 of file odbcDatabase.cpp.

References odbcWrap().

                                                                     :
  Database( userName ), odbcEnvironment( NULL ), connection( NULL )
{
  
  bool connected = false;

  try {
    // 1. allocate Environment handle and register version 
    odbcWrap( SQLAllocHandle( SQL_HANDLE_ENV, SQL_NULL_HANDLE,
                              &odbcEnvironment ), SQL_NULL_HANDLE, NULL );
    
    odbcWrap( SQLSetEnvAttr( odbcEnvironment, SQL_ATTR_ODBC_VERSION,
                             (void*)SQL_OV_ODBC3, 0 ),
              SQL_HANDLE_ENV, odbcEnvironment );

    odbcWrap( SQLAllocHandle( SQL_HANDLE_DBC, odbcEnvironment, &connection ),
              SQL_HANDLE_ENV, odbcEnvironment );

    // 2. allocate connection handle, set timeout
    odbcWrap( SQLSetConnectAttr( connection, SQL_LOGIN_TIMEOUT,
                                 (SQLPOINTER *)5, 0 ),
              SQL_HANDLE_DBC, connection );

    // 3. Connect to the datasource "web" 
    odbcWrap( SQLConnect( connection, (SQLCHAR*)databaseName.c_str(), SQL_NTS,
                          (SQLCHAR*)userName.c_str(), SQL_NTS,
                          (SQLCHAR*)passWord.c_str(), SQL_NTS ),
              SQL_HANDLE_DBC, connection );

    connected = true;

  } catch ( Error &e ) {

    if ( connected ) {
      assert( connection );
      SQLDisconnect( connection );
    };
    if ( connection )
      SQLFreeHandle( SQL_HANDLE_DBC, connection );
    if ( odbcEnvironment )
      SQLFreeHandle( SQL_HANDLE_ENV, odbcEnvironment );
    throw e;

  };

};

ODBCDatabase::~ODBCDatabase

(

void

)

[virtual]

Destructor.

Definition at line 73 of file odbcDatabase.cpp.

References connection, and odbcEnvironment.

{
  assert( connection );
  SQLDisconnect( connection );
  SQLFreeHandle( SQL_HANDLE_DBC, connection );
  assert( odbcEnvironment );
  SQLFreeHandle( SQL_HANDLE_ENV, odbcEnvironment );
}

---

Member Function Documentation

StatementPtr ODBCDatabase::execQuery

(

const std::string &

query

)

throw (Error) [virtual]

Execute single query. The returned Statement object allows requesting the results of the query.

Implements Database.

Definition at line 82 of file odbcDatabase.cpp.

References connection.

{
  StatementPtr retVal( new ODBCStatement( connection, query ) );
  return retVal;
}

---

Field Documentation

SQLHENV ODBCDatabase::odbcEnvironment [protected]

ODBC environment handle.

Definition at line 44 of file odbcDatabase.hpp.

Referenced by ~ODBCDatabase().

SQLHDBC ODBCDatabase::connection [protected]

Connection handle.

Definition at line 46 of file odbcDatabase.hpp.

Referenced by execQuery(), and ~ODBCDatabase().

---

The documentation for this class was generated from the following files:

• odbcDatabase.hpp
• odbcDatabase.cpp

---