Twin class for IldDbms, with inheritance capability. More...

#include <ildblink/dbmsmodl.h>

Inheritance diagram for IldDbmsModel:

Public Member Functions
	IldDbmsModel (const char dbmsName, const char conStr)
	As `IldNewDbms(const char, const char)`.

	IldDbmsModel (const char dbmsName, const char database, const char userName, const char password)
	As `IldNewDbms(const char, const char, const char, const char)`.

virtual IldDbms &	autoCommitOff (IldRequest request=0, const char transName=0)
	As `IldDbms::autoCommitOff(IldRequest, const char)`.

virtual IldDbms &	autoCommitOn (IldRequest request=0, const char transName=0)
	As `IldDbms::autoCommitOn(IldRequest, const char)`.

virtual IldDbms &	cancel ()
	As `IldDbms::cancel()`.

virtual IldDbms &	commit (IldRequest request=0, const char transName=0)
	As `IldDbms::commit(IldRequest, const char)`.

virtual IldDbms &	connect (const char *connString)
	As `IldDbms::connect(const char*)`.

virtual IldDbms &	connect (const char database, const char userName, const char *password)
	As `IldDbms::connect(const char, const char, const char*)`.

virtual IldDbms &	disconnect ()
	As `IldDbms::disconnect()`.

IldDbms &	execute (const char query, IlInt rowCount=0)
	As `IldDbms::execute(const char, IlInt)`.

virtual void	freeEntity (IldSchemaEntity *ent)
	As `IldDbms::freeEntity(IldSchemaEntity*)`.

virtual IldDbms &	freeNames (char names, char owners=0)
	As `IldDbms::freeNames(char, char)`.

virtual void	freeTypeInfo (const IldSQLType **)
	As `IldDbms::freeTypeInfo(const IldSQLType*)`.

virtual IldADTDescriptor *	getAbstractType (const char typeName, const char owner=0)
	As `IldDbms::getAbstractType(const char, const char)`.

virtual IldADTDescriptor *	getAbstractType (IlInt typeId)
	As `IldDbms::getAbstractType(IlInt)`.

const char *	getDatabase () const
	As `IldDbms::getDatabase()`.

const char *	getDbmsServer () const
	As `IldDbms::getDbmsServer()`.

virtual IlUInt	getDbmsVersion ()
	As `IldDbms::getDbmsVersion()`.

virtual const char *	getDbmsVersions ()
	As `IldDbms::getDbmsVersions()`.

virtual IlUInt	getDefaultColArraySize () const
	As `IldDbms::getDefaultColArraySize()`.

virtual IlUInt	getDefaultParamArraySize () const
	As `IldDbms::getDefaultParamArraySize()`.

virtual IldErrorReporter *	getErrorReporter () const
	As `IldDbms::getErrorReporter()`.

virtual IlAny	getHook () const
	As `IldDbms::getHook()`.

virtual IldDbms &	getInfo (IldInfoItem info, IlInt intVal, char charVal)
	As `IldDbms::getInfo(IldInfoItem, IlInt, char)`.

const char *	getName () const
	As `IldDbms::getName()`.

IlInt	getNumberOfActiveConnections () const
	As `IldDbms::getNumberOfActiveConnections()`.

virtual IlUInt	getNumberOfEntities ()
	As `IldDbms::getNumberOfEntitiess()`.

virtual IlUInt	getNumberOfRequests () const
	As `IldDbms::getNumberOfRequests()`.

virtual IldCallable *	getProcedure (const char procName, const char owner=0)
	As `IldDbms::getProcedure(const char, const char)`.

virtual IldCallable *	getProcedure (IlInt procId)
	As `IldDbms::getProcedure(IlInt)`.

virtual IldRelation *	getRelation (const char relName, const char owner=0)
	As `IldDbms::getRelation(const char, const char)`.

virtual IldRelation *	getRelation (IlInt relId)
	As `IldDbms::getRelation(IlInt)`.

virtual IldSynonym *	getSynonym (const char synName, const char owner=0)
	As `IldDbms::getSynonym(const char, const char)`.

virtual IldSynonym *	getSynonym (IlInt synId)
	As `IldDbms::getSynonym(IlInt)`.

virtual const IldSQLType **	getTypeInfo (short cTy=IldSQLAllTypes)
	As `IldDbms::getTypeInfo(short)`.

const char *	getUser () const
	As `IldDbms::getUser()`.

virtual IlBoolean	isAsync () const
	As `IldDbms::isAsync()`.

virtual IlBoolean	isAsyncSupported () const
	As `IldDbms::isAsyncSupported()`.

virtual IlBoolean	isCompleted () const
	As `IldDbms::isCompleted()`.

virtual IlBoolean	isConnected () const
	As `IldDbms::isConnected()`.

virtual IlBoolean	isReadOnlyCapable () const
	As `IldDbms::isReadOnlyCapable()`.

virtual IlBoolean	isScrollableCapable () const
	As `IldDbms::isScrollableCapable()`.

virtual IlBoolean	isTransactionEnabled ()
	As `IldDbms::isTransactionEnabled()`.

virtual IlBoolean	isTransactionReadOnly () const
	As `IldDbms::isTransactionReadOnly()`.

virtual IldADTDescriptor *	readAbstractType (const char typeName, const char owner=0)
	As `IldDbms::readAbstractType(const char, const char)`.

virtual IldADTDescriptor *	readAbstractType (IlInt typeId)
	As `IldDbms::readAbstractType(IlInt)`.

virtual char **	readAbstractTypeNames (const char *owner=0)
	As `IldDbms::readAbstractTypeNames(const char*)`.

virtual IldRequest *	readEntityNames (IldEntityType entType, const char *owner=0)
	As `IldDbms::readEntityNames(IldEntityType, const char*)`.

virtual IldDbms &	readForeignKeys (IldRelation *relation)
	Build the descriptor of the relation foreign keys. More...

virtual IldDbms &	readIndexes (IldRelation *relation)
	Build the descriptor of the relation indexes. More...

virtual char **	readOwners ()
	As `IldDbms::readOwners()`.

virtual IldDbms &	readPrimaryKey (IldRelation *relation)
	Build the descriptor of the relation primary key. More...

virtual IldCallable *	readProcedure (const char procName, const char owner=0)
	As `IldDbms::readProcedure(const char, const char)`.

virtual IldCallable *	readProcedure (IlInt procId)
	As `IldDbms::readProcedure(IlInt)`.

virtual char **	readProcedureNames (const char *owner=0)
	As `IldDbms::readProcedureNames(const char*)`.

virtual IldRelation *	readRelation (const char relName, const char owner=0)
	As `IldDbms::readRelation(const char, const char)`.

virtual IldRelation *	readRelation (IlInt relId)
	As `IldDbms::readRelation(IlInt)`.

virtual char **	readRelationNames (char **&owners)
	As `IldDbms::readRelationNames(char**& owners)`.

virtual char **	readRelationNames (const char *owner=0)
	As `IldDbms::readRelationNames(const char*)`.

virtual char **	readRelationOwners (const char *relName=0)
	As `IldDbms::readRelationOwners(const char*)`.

virtual IldDbms &	readSpecialColumns (IldRelation *relation)
	Build the descriptor of the relation special columns. More...

virtual IldSynonym *	readSynonym (const char synName, const char owner=0)
	As `IldDbms::readSynonym(const char, const char)`.

virtual IldSynonym *	readSynonym (IlInt synId)
	As `IldDbms::readSynonym(IlInt)`.

virtual char **	readSynonymNames (const char *owner=0)
	As `IldDbms::readSynonymNames(const char*)`.

virtual IldRequest *	readTablePrivileges (const char catalog, const char schema, const char *table)
	As `IldDbms::readTablePrivileges(const char, const char, const char*)`.

virtual void	removeEntity (IldSchemaEntity *ent)
	As `IldDbms::removeEntity(IldSchemaEntity*)`.

virtual void	removeRelation (IldRelation *rel)
	As `IldDbms::removeRelation(IldRelation*)`.

virtual IldDbms &	rollback (IldRequest request=0, const char transName=0)
	As `IldDbms::rollback(IldRequest, const char)`.

virtual IldDbms &	setAsync (IlBoolean)
	As `IldDbms::setAsync(IlBoolean)`.

virtual IldDbms &	setDefaultColArraySize (IlUInt size)
	As `IldDbms::setDefaultColArraySize(IlUInt)`.

virtual IldDbms &	setDefaultParamArraySize (IlUInt size)
	Set the default parameter array size. More...

virtual IldDbms &	setErrorReporter (IldErrorReporter *reporter)
	As `IldDbms::setErrorReporter(IldErrorReporter*)`.

virtual IldDbms &	setHook (IlAny hook)
	As `IldDbms::setHook()`.

virtual IldDbms &	setTimeOut (short secs)
	As `IldDbms::setTimeOut(short)`.

virtual IldDbms &	setTransactionReadOnly (IlBoolean flag=IlTrue)
	As `IldDbms::setTransactionReadOnly()`.

virtual IldDbms &	startTransaction (IldRequest request=0, const char transName=0)
	As `IldDbms::startTransaction(IldRequest, const char)`.

virtual IldDbms &	subscribeEvent (const char *name, IldNotifFunction usrCB, IlAny usrData)
	As `IldDbms::subscribeEvent(const char*, IldNotifFunction, IlAny)`.

virtual IldDbms &	unSubscribeEvent (const char *name)
	As `IldDbms::unSubscribeEvent(const char*)`.

Public Member Functions inherited from IldBaseModel
const IldDiagnostic *	getError () const
	As `IldIldBase::getError`.

IlInt	getErrorCode () const
	As `IldIldBase::getErrorCode`.

const char *	getErrorConnection () const
	As `IldIldBase::getErrorConnection`.

const char *	getErrorMessage () const
	As `IldIldBase::getErrorMessage`.

const char *	getErrorName () const
	As `IldIldBase::getErrorName`.

IldErrorOrigin	getErrorOrigin () const
	As `IldIldBase::getErrorOrigin`.

const char *	getErrorSqlstate () const
	As `IldIldBase::getErrorSqlState`.

const IldDiagnostic *	getInformation () const
	As `IldIldBase::getInformation`.

IlInt	getInformationCode () const
	As `IldIldBase::getInformationCode`.

const char *	getInformationMessage () const
	As `IldIldBase::getInformationMessage`.

IlBoolean	isErrorRaised () const
	As `IldIldBase::isErrorRaised`.

IlBoolean	isInformationRaised () const
	As `IldIldBase::isInformationRaised`.

int	operator! () const
	As `IldIldBase::operator!`.

void	setError (IldDiagnostic *)
	As `IldIldBase::setError`.

void	setInformation (IldDiagnostic *)
	As `IldIldBase::setInformation`.

virtual void	setNumericUse (IlBoolean flag)
	As `IldIldBase::setNumericUse`.

virtual void	setStringDateUse (IlBoolean flag=IlTrue)
	As `IldIldBase::setStringDateUse`.

virtual void	setStringNumericUse (IlBoolean flag=IlTrue)
	As `IldIldBase::setStringNumericUse`.

virtual IlBoolean	useNumeric () const
	As `IldIldBase::useNumeric`.

virtual IlBoolean	useStringDate () const
	As `IldIldBase::useStringDate`.

virtual IlBoolean	useStringNumeric () const
	As `IldIldBase::useStringNumeric`.

Public Member Functions inherited from IldIldBase
virtual	~IldIldBase ()
	Destructor for the base class of DB Link session and cursor classes. More...

void	clearDiagnostics ()
	Set diagnostic flags to false. More...

Public Member Functions inherited from IldDbms
virtual	~IldDbms ()
	This virtual destructor is invoked when the current object is being destroyed. More...

Protected Member Functions
IldRequest *	getFreeRequest ()
	Get a new request. More...

Friends
class	IldRequestModel

Detailed Description

Twin class for IldDbms, with inheritance capability.

Library: dbkernel

Since the IldDbms and IldRequest classes cannot be inherited, new classes IldDbmsModel and IldRequestModel are provided. They offer the same functionalities as the IldDbms and IldRequest classes, and they can be inherited.

Therefore, the description of the various member functions is essentially the same as the description given in the IldDbms class. Differences are the following :

Elements of this class are allocated naturally via its constructor. Because there is no public constructor for the IldDbms class, such objects are instantiated using the function IldNewDbms.
Similarly, the getFreeRequest function cannot be used by instances of this class. Request objects are allocated using their constructor.
Since IldRequestModel instances are allocated using their constructor, the IldDbmsModel destructor cannot release all requests attached to it.

Member Function Documentation

IldRequest* IldDbmsModel::getFreeRequest ( )

protectedvirtual

Get a new request.

Returns: A pointer to an IldRequest object.

The object may be one that already exists and has been released, or it may be a new object.

This member function can raise the following errors:

ILD_DBMS_NOT_CONNECTED
ILD_MEMORY_EXHAUSTED
Any error detected by the RDBMS itself.

In case of error, this member function returns a null pointer or an error request object.

For more information on these return values, see the section "Erroneous IldDbms and IldRequest Objects" in the Rogue Wave DB Link User's Manual.

Implements IldDbms.

virtual IldDbms& IldDbmsModel::readForeignKeys ( IldRelation * rel )

virtual

Build the descriptor of the relation foreign keys.

Parameters

rel	The relation whose foreign keys descriptors are to be retrieved.

Returns: The current object by reference.

Implements IldDbms.

virtual IldDbms& IldDbmsModel::readIndexes ( IldRelation * rel )

virtual

Build the descriptor of the relation indexes.

Parameters

rel	The relation whose index descriptors are to be retrieved.

Returns: The current object by reference.

Implements IldDbms.

virtual IldDbms& IldDbmsModel::readPrimaryKey ( IldRelation * rel )

virtual

Build the descriptor of the relation primary key.

Parameters

rel	The realtion whose primary descriptor is to be built.

Returns: The current object by reference.

Implements IldDbms.

virtual IldDbms& IldDbmsModel::readSpecialColumns ( IldRelation * rel )

virtual

Build the descriptor of the relation special columns.

Parameters

rel	The relation whose special columns descriptor is to be built.

Returns: The current object by reference.

Implements IldDbms.

virtual IldDbms& IldDbmsModel::setDefaultParamArraySize ( IlUInt size )

virtual

Set the default parameter array size.

Parameters

size	The default number of parameter rows that will be sent simultaneously to the server by an `IldRequest` object issued from the current connection when executing a query.

Returns: The current object by reference.

Implements IldDbms.

Rogue Wave DBLink API Reference Guide

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Function Documentation