DatabaseHandler is a class taking care of the micro-connections and the micro transactions for a given database. More...

#include <DatabaseHandler.h>

Collaboration diagram for pool::DatabaseHandler:

Public Member Functions
	DatabaseHandler (IStorageSvc &storageSvc, long technology, const std::string &fid, const std::string &pfn, Io::IoFlag accessmode)
	Constructor. Connects to the database.
	~DatabaseHandler ()
	Destructor. Disconnects from the database.
bool	commitTransaction ()
	Commits the transaction.
bool	commitAndHoldTransaction ()
	Commits and holds the transaction.
bool	disconnectTransaction ()
	Disconnects the transaction.
std::vector< std::string >	containers ()
	Gives the list of containers.
IContainer *	container (const std::string &containerName)
	Returns a container handle.
const std::string &	pfn () const
	Returns the physical file name.
const std::string &	fid () const
	Returns the file identifier.
long	technology () const
	Returns the technology identifier.
Io::IoFlag	accessMode () const
	Returns the access mode.
Token *	writeObject (const std::string &containerName, long minorTechnology, const void *object, const RootType &type)
	Writes an object and returns a token.
void *	readObject (const Token &token, void *object=0)
	Reads an object given a token.
bool	attribute (const std::string &attributeName, void *data, const std::type_info &typeInfo, const std::string &option)
	Returns an attribute.
bool	setAttribute (const std::string &attributeName, const void *data, const std::type_info &typeInfo, const std::string &option)
	Sets an attrtibute.

Private Attributes
IStorageSvc &	m_storageSvc
	IStorageSvc reference.
FileDescriptor	m_fileDescriptor
	File descriptor for this database.
long	m_technology
	Technology identifier.
Io::IoFlag	m_accessMode
	Current access mode.

Detailed Description

DatabaseHandler is a class taking care of the micro-connections and the micro transactions for a given database.

It also gives access to the underlying containers.

Definition at line 30 of file DatabaseHandler.h.

Constructor & Destructor Documentation

◆ DatabaseHandler()

pool::DatabaseHandler::DatabaseHandler	(	pool::IStorageSvc &	storageSvc,
		long	technology,
		const std::string &	fid,
		const std::string &	pfn,
		Io::IoFlag	accessmode )

Constructor. Connects to the database.

Definition at line 20 of file DatabaseHandler.cxx.

                                                                             :
  m_storageSvc( storageSvc ),
  m_fileDescriptor( fid, pfn ),
  m_technology( technology ),
  m_accessMode( accessmode )
{
  if ( ! m_storageSvc.connect( m_accessMode, m_fileDescriptor ).isSuccess() ) {
    throw std::runtime_error( "Could not connect to the database (APR: \" DatabaseHandler::DatabaseHandler \" from \" PersistencySvc \")" );
  }
}

◆ ~DatabaseHandler()

pool::DatabaseHandler::~DatabaseHandler ( )

Destructor. Disconnects from the database.

Definition at line 35 of file DatabaseHandler.cxx.

{
   Io::IoFlag mode = Io::INVALID;
   if( m_storageSvc.openMode(m_fileDescriptor, mode).isSuccess() ) {
     m_storageSvc.disconnect( m_fileDescriptor ).ignore();
   }
}

Member Function Documentation

◆ accessMode()

Io::IoFlag pool::DatabaseHandler::accessMode ( ) const

Returns the access mode.

Definition at line 122 of file DatabaseHandler.cxx.

{
  return m_accessMode;
}

◆ attribute()

bool pool::DatabaseHandler::attribute	(	const std::string &	attributeName,
		void *	data,
		const std::type_info &	typeInfo,
		const std::string &	option )

Returns an attribute.

Definition at line 176 of file DatabaseHandler.cxx.

{
  pool::DbOption databaseOption( attributeName, option );
  DbDatabase dbH( m_fileDescriptor.dbc()->handle() );
  if( !dbH.getOption(databaseOption).isSuccess() ) return false;
  return databaseOption.i_getValue(typeInfo, data).isSuccess();
}

◆ commitAndHoldTransaction()

bool pool::DatabaseHandler::commitAndHoldTransaction ( )

Commits and holds the transaction.

Definition at line 53 of file DatabaseHandler.cxx.

{
   return m_storageSvc.endTransaction( m_fileDescriptor, Transaction::TRANSACT_COMMIT ).isSuccess();
}

◆ commitTransaction()

bool pool::DatabaseHandler::commitTransaction ( )

Commits the transaction.

Definition at line 45 of file DatabaseHandler.cxx.

{
   return m_storageSvc.endTransaction( m_fileDescriptor, Transaction::TRANSACT_COMMIT ).isSuccess() &&
          m_storageSvc.endTransaction( m_fileDescriptor, Transaction::TRANSACT_FLUSH ).isSuccess();
}

◆ container()

pool::IContainer * pool::DatabaseHandler::container ( const std::string & containerName )

Returns a container handle.

Definition at line 84 of file DatabaseHandler.cxx.

{
   // Check the existence of a given container.
   std::vector< std::string > allContainers = this->containers();
   for ( std::vector< std::string >::const_iterator iName = allContainers.begin();
         iName != allContainers.end(); ++iName ) {
      if ( *iName == containerName ) {
         return new pool::Container( m_fileDescriptor,
                                                     m_technology,
                                                     containerName );
      }
   }
   return 0;
}

◆ containers()

std::vector< std::string > pool::DatabaseHandler::containers ( )

Gives the list of containers.

Definition at line 66 of file DatabaseHandler.cxx.

{
   std::vector< std::string > result;
   std::vector<const Token*> containerTokens;
   DbDatabase dbH( m_fileDescriptor.dbc()->handle() );
   if( !dbH.containers(containerTokens, false).isSuccess() ) {
      DbPrint log( m_fileDescriptor.PFN() );
      log << MSG::ERROR << "Could not retrieve the list of containers." << endmsg;
   }
   for ( std::vector<const Token*>::const_iterator iToken = containerTokens.begin();
         iToken != containerTokens.end(); ++iToken ) {
      Token tok (*iToken);
      result.push_back( m_storageSvc.getContName(m_fileDescriptor, tok) );
   }
   return result;
}

◆ disconnectTransaction()

bool pool::DatabaseHandler::disconnectTransaction ( )

Disconnects the transaction.

Definition at line 60 of file DatabaseHandler.cxx.

{
   return ( m_storageSvc.disconnect( m_fileDescriptor ).isSuccess() );
}

◆ fid()

const std::string & pool::DatabaseHandler::fid ( ) const

Returns the file identifier.

Definition at line 108 of file DatabaseHandler.cxx.

{
  return m_fileDescriptor.FID();
}

◆ pfn()

const std::string & pool::DatabaseHandler::pfn ( ) const

Returns the physical file name.

Definition at line 101 of file DatabaseHandler.cxx.

{
  return m_fileDescriptor.PFN();
}

◆ readObject()

void * pool::DatabaseHandler::readObject	(	const Token &	token,
		void *	object = 0 )

Reads an object given a token.

Definition at line 158 of file DatabaseHandler.cxx.

{
  void* result( object );
 
  // Get the persistent shape
  const pool::Shape* shape = nullptr;
  if( !m_storageSvc.getShape( m_fileDescriptor, token.classID(), shape ).isSuccess() ) {
    return result;
  }
  if( !m_storageSvc.read( m_fileDescriptor, token, shape, &result ).isSuccess() ) {
    return nullptr;
  }
  
  return result;
}

◆ setAttribute()

bool pool::DatabaseHandler::setAttribute	(	const std::string &	attributeName,
		const void *	data,
		const std::type_info &	typeInfo,
		const std::string &	option )

Sets an attrtibute.

Definition at line 189 of file DatabaseHandler.cxx.

{
  pool::DbOption databaseOption( attributeName, option );
  if( !databaseOption.i_setValue( typeInfo, const_cast<void*>( data ) ).isSuccess() ) return false;
  DbDatabase dbH( m_fileDescriptor.dbc()->handle() );
  return dbH.setOption(databaseOption).isSuccess();
  }

◆ technology()

long pool::DatabaseHandler::technology ( ) const

Returns the technology identifier.

Definition at line 115 of file DatabaseHandler.cxx.

{
  return m_technology;
}

◆ writeObject()

Token * pool::DatabaseHandler::writeObject	(	const std::string &	containerName,
		long	minorTechnology,
		const void *	object,
		const RootType &	type )

Writes an object and returns a token.

Definition at line 129 of file DatabaseHandler.cxx.

{
  Token* token = 0;
  if ( ! object ) return token;
 
  // Get the persistent shape.
  const pool::Shape* shape = nullptr;
  Guid guid = DbReflex::guid(type);
  if( !m_storageSvc.getShape( m_fileDescriptor, guid, shape ).isSuccess() ) {
     shape = m_storageSvc.createShape( guid );
  }
  if ( shape )  {
    if ( m_storageSvc.allocate( m_fileDescriptor,
                                containerName,
                                minorTechnology,
                                object,
                                shape, 
                                token ).isSuccess() ) {
      token->setClassID( shape->shapeID() );
    }
  }
  return token;
}

Member Data Documentation

◆ m_accessMode

Io::IoFlag pool::DatabaseHandler::m_accessMode

private

Current access mode.

Definition at line 98 of file DatabaseHandler.h.

◆ m_fileDescriptor

FileDescriptor pool::DatabaseHandler::m_fileDescriptor

private

File descriptor for this database.

Definition at line 94 of file DatabaseHandler.h.

◆ m_storageSvc

IStorageSvc& pool::DatabaseHandler::m_storageSvc

private

IStorageSvc reference.

Definition at line 92 of file DatabaseHandler.h.

◆ m_technology

long pool::DatabaseHandler::m_technology

private

Technology identifier.

Definition at line 96 of file DatabaseHandler.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DatabaseHandler()

◆ ~DatabaseHandler()

Member Function Documentation

◆ accessMode()

◆ attribute()

◆ commitAndHoldTransaction()

◆ commitTransaction()

◆ container()

◆ containers()

◆ disconnectTransaction()

◆ fid()

◆ pfn()

◆ readObject()

◆ setAttribute()

◆ technology()

◆ writeObject()

Member Data Documentation

◆ m_accessMode

◆ m_fileDescriptor

◆ m_storageSvc

◆ m_technology