pool::IDbDatabase Class Reference

#include <StorageSvc/IDbDatabase.h>

Inheritance diagram for pool::IDbDatabase:

Collaboration diagram for pool::IDbDatabase:

Public Member Functions
virtual	~IDbDatabase ()
virtual long long int	size () const =0
	Access the size of the database: May be undefined for some technologies. More...
virtual DbStatus	setOption (const DbOption &refOpt)=0
	Set options. More...
virtual DbStatus	getOption (DbOption &refOpt)=0
	Access options. More...
virtual DbStatus	close (DbAccessMode mode)=0
	Close database access. More...
virtual DbStatus	open (const DbDomain &domH, const std::string &nam, DbAccessMode mode)=0
	Open Database object. More...
virtual DbStatus	onOpen (DbDatabase &dbH, DbAccessMode mode)=0
	Callback after successful open of a database object. More...
virtual DbStatus	reopen (DbAccessMode mode)=0
	Re-open database with changing access permissions. More...
virtual DbStatus	transAct (Transaction::Action action)=0
	Execute Database Transaction action. More...

Detailed Description

IDbDatabase interface

Description: Interface to the implementation specific part of a Database object

Author

M.Frank

Version

1.0

Definition at line 41 of file IDbDatabase.h.

Constructor & Destructor Documentation

~IDbDatabase()

virtual pool::IDbDatabase::~IDbDatabase ( )

inlinevirtual

Definition at line 43 of file IDbDatabase.h.

{ }

Member Function Documentation

close()

virtual DbStatus pool::IDbDatabase::close ( DbAccessMode  mode )

pure virtual

Close database access.

Parameters

mode	[IN] Desired session access mode.

Returns

DbStatus code indicating success or failure.

Implemented in pool::RootDatabase.

getOption()

virtual DbStatus pool::IDbDatabase::getOption ( DbOption &  refOpt )

pure virtual

Access options.

Parameters

refOpt

[IN] Reference to option object.

Returns

DbStatus code indicating success or failure.

Implemented in pool::RootDatabase.

onOpen()

virtual DbStatus pool::IDbDatabase::onOpen ( DbDatabase &  dbH, DbAccessMode  mode  )

pure virtual

Callback after successful open of a database object.

Parameters

dbH	[IN] Handle to valid database object
mode	[IN] Desired session access mode.

Returns

DbStatus code indicating success or failure.

Implemented in pool::RootDatabase.

open()

virtual DbStatus pool::IDbDatabase::open ( const DbDomain &  domH, const std::string &  nam, DbAccessMode  mode  )

pure virtual

Open Database object.

Parameters

domH	[IN] Handle to valid domain object (validity ensured by upper levels).
nam	[IN] Name of the database to be opened.
mode	[IN] Desired session access mode.

Returns

DbStatus code indicating success or failure.

Implemented in pool::RootDatabase.

reopen()

virtual DbStatus pool::IDbDatabase::reopen ( DbAccessMode  mode )

pure virtual

Re-open database with changing access permissions.

Parameters

mode	[IN] Desired session access mode.

Returns

DbStatus code indicating success or failure.

Implemented in pool::RootDatabase.

setOption()

virtual DbStatus pool::IDbDatabase::setOption ( const DbOption &  refOpt )

pure virtual

Set options.

Parameters

refOpt

[IN] Reference to option object.

Returns

DbStatus code indicating success or failure.

Implemented in pool::RootDatabase.

size()

virtual long long int pool::IDbDatabase::size ( ) const

pure virtual

Access the size of the database: May be undefined for some technologies.

Implemented in pool::RootDatabase.

transAct()

virtual DbStatus pool::IDbDatabase::transAct ( Transaction::Action  action )

pure virtual

Execute Database Transaction action.

Parameters

action

[IN] action to perform

Returns

Status code indicating success or failure.

Implemented in pool::RootDatabase.

---

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

• IDbDatabase.h