NCBI C++ ToolKit
Public Member Functions | List of all members
IResultSetMetaData Class Referenceabstract

Search Toolkit Book for IResultSetMetaData

IResultSetMetaData –. More...

#include <dbapi/dbapi.hpp>

+ Inheritance diagram for IResultSetMetaData:

Public Member Functions

virtual ~IResultSetMetaData (void)
 Destructor. More...
 
bool HasColumn (const CDBParamVariant &param) const
 Convenience method to check whether a column with a given name (or number) actually exists. More...
 
virtual unsigned int GetTotalColumns (void) const =0
 Get total number of columns in resultset. More...
 
virtual EDB_Type GetType (const CDBParamVariant &param) const =0
 Get data type for column in the resultset. More...
 
virtual int GetMaxSize (const CDBParamVariant &param) const =0
 Get maximum size in bytes for column. More...
 
virtual string GetName (const CDBParamVariant &param) const =0
 Get name of column. More...
 
virtual CDBParams::EDirection GetDirection (const CDBParamVariant &param) const =0
 Get parameter's direction (in/out/inout). More...
 

Detailed Description

IResultSetMetaData –.

Interface class defines retrieving column information from a resultset, such as total number of columns, type, name, etc.

Definition at line 107 of file dbapi.hpp.

Constructor & Destructor Documentation

IResultSetMetaData::~IResultSetMetaData ( void  )
virtual

Destructor.

Clean up the metadata for the resultset.

Definition at line 118 of file dbapi.cpp.

Member Function Documentation

virtual CDBParams::EDirection IResultSetMetaData::GetDirection ( const CDBParamVariant param) const
pure virtual

Get parameter's direction (in/out/inout).

Parameters
paramColumn number or name

Implemented in CStatement::CStmtParamsMetaData, and CResultSetMetaData.

Referenced by python::CCallableStmtHelper::SetParam().

virtual int IResultSetMetaData::GetMaxSize ( const CDBParamVariant param) const
pure virtual

Get maximum size in bytes for column.

Parameters
colColumn number
Returns
Max number of bytes needed to hold the returned data.

Implemented in CStatement::CStmtParamsMetaData, and CResultSetMetaData.

Referenced by python::s_FillDescription().

virtual string IResultSetMetaData::GetName ( const CDBParamVariant param) const
pure virtual
virtual unsigned int IResultSetMetaData::GetTotalColumns ( void  ) const
pure virtual

Get total number of columns in resultset.

Implemented in CStatement::CStmtParamsMetaData, and CResultSetMetaData.

Referenced by HasColumn(), CDbapiSimpleApp::RetrieveData(), and python::s_FillDescription().

virtual EDB_Type IResultSetMetaData::GetType ( const CDBParamVariant param) const
pure virtual

Get data type for column in the resultset.

Parameters
paramColumn number or name

Implemented in CStatement::CStmtParamsMetaData, and CResultSetMetaData.

Referenced by CQueryImpl::GetColumnType(), python::s_FillDescription(), and python::CCallableStmtHelper::SetParam().

bool IResultSetMetaData::HasColumn ( const CDBParamVariant param) const

Convenience method to check whether a column with a given name (or number) actually exists.

Definition at line 122 of file dbapi.cpp.

References CDBParamVariant::GetName(), GetName(), CDBParamVariant::GetPosition(), GetTotalColumns(), i, CDBParamVariant::IsPositional(), and n.


The documentation for this class was generated from the following files:
Modified on Sun Aug 30 15:38:17 2015 by modify_doxy.py rev. 426318