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

ODBCStatement Class Reference

#include <odbcStatement.hpp>

Inheritance diagram for ODBCStatement:

[legend]

Public Member Functions
	ODBCStatement (SQLHDBC connection, const std::string &query) throw (Error)
virtual	~ODBCStatement (void)
	Destructor frees the statement handle.
virtual int	getNumCols (void) throw (Error)
virtual std::string	getColAttr (int col) throw (Error)
virtual ResultRowPtr &	fetchRow (void) throw (Error)
	Fetch row of resulting row.
Protected Attributes
SQLHSTMT	statement
ResultRowPtr	resultRow

---

Detailed Description

Class for executing SQL query and querying results.

Deprecated:

{The ODBC classes are not in use at the moment} Call ODBCDatabase::execQuery to acquire an instance of this class.

Date:

Thu Mar 03 2005

Author:

Jan Wedekind (wedesoft@users.sourceforge.net)

Definition at line 28 of file odbcStatement.hpp.

---

Constructor & Destructor Documentation

ODBCStatement::ODBCStatement	(	SQLHDBC	connection,
		const std::string &	query
	)			throw (Error)

Constructor requiring SQLHDBC handle. Call ODBCDatabase::execQuery to acquire an instance of this class.

See also:

ODBCDatabase::execQuery

Definition at line 23 of file odbcStatement.cpp.

References ERRORMACRO, odbcWrap(), and Error::what().

               :
  statement( NULL )
{
  try {
    if ( !query.empty() ) {
      odbcWrap( SQLAllocHandle( SQL_HANDLE_STMT, connection, &statement ),
                SQL_HANDLE_STMT, statement );

      assert( statement );
      assert( sizeof( char ) == sizeof( SQLCHAR ) );
#ifndef NDEBUG
      cerr << query << endl;
#endif
      odbcWrap( SQLExecDirect( statement, (SQLCHAR *)query.c_str(), SQL_NTS ),
                SQL_HANDLE_STMT, statement );
    };
  } catch ( Error &e ) {
    if ( statement )
      SQLFreeHandle( SQL_HANDLE_STMT, statement );
    ERRORMACRO( false, Error, ,
                "Error in query \"" << query << "\": " << e.what() );
  }
}

ODBCStatement::~ODBCStatement

(

void

)

[virtual]

Destructor frees the statement handle.

Definition at line 48 of file odbcStatement.cpp.

References resultRow, and statement.

{
  if ( resultRow )
    resultRow->invalidate();
  if( statement )
    SQLFreeHandle( SQL_HANDLE_STMT, statement );
}

---

Member Function Documentation

int ODBCStatement::getNumCols

(

void

)

throw (Error) [virtual]

Get number of result columns.

Returns:

Number of resulting columns of a SELECT query. 0 if there is none.

Implements Statement.

Definition at line 56 of file odbcStatement.cpp.

References odbcWrap(), and statement.

Referenced by getColAttr().

{
  SQLSMALLINT retVal;
  if ( statement )
    odbcWrap( SQLNumResultCols( statement, &retVal ),
              SQL_HANDLE_STMT, statement );
  else
    retVal = 0;
  return retVal;
}

std::string ODBCStatement::getColAttr

(

int

col

)

throw (Error) [virtual]

Meta information about column.

Parameters:

col

Number of column (between 0 and getNumCols()-1).

Implements Statement.

Definition at line 67 of file odbcStatement.cpp.

References ERRORMACRO, getNumCols(), and statement.

{
  SQLCHAR retVal[4096];
  ERRORMACRO( col >= 0 && col < getNumCols(), Error, ,
              "Column number of meta-column must be between 0 and "
              << ( getNumCols() - 1 ) << " but was " << col << "." );
  SQLColAttribute( statement, col + 1, SQL_DESC_LABEL, retVal,
                   sizeof(retVal), NULL, NULL );
  assert( sizeof( SQLCHAR ) == sizeof( char ) );
  return (char *)retVal;
}

ResultRowPtr & ODBCStatement::fetchRow

(

void

)

throw (Error) [virtual]

Fetch row of resulting row.

Implements Statement.

Definition at line 79 of file odbcStatement.cpp.

References ERRORMACRO, resultRow, and statement.

{
  if ( resultRow ) {
    ERRORMACRO( resultRow.use_count() <= 1, Error, ,
                "Can not fetch new row, "
                "because previous row was not released yet." );
    assert( resultRow.use_count() == 1 );
  };
  if ( SQL_SUCCEEDED( SQLFetch( statement ) ) )
    resultRow = ResultRowPtr( new ODBCResultRow( statement ) );
  else
    resultRow.reset();
  return resultRow;
}

---

Field Documentation

SQLHSTMT ODBCStatement::statement [protected]

Definition at line 45 of file odbcStatement.hpp.

Referenced by fetchRow(), getColAttr(), getNumCols(), and ~ODBCStatement().

ResultRowPtr ODBCStatement::resultRow [protected]

Definition at line 47 of file odbcStatement.hpp.

Referenced by fetchRow(), and ~ODBCStatement().

---

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

• odbcStatement.hpp
• odbcStatement.cpp

---