SqliteReadSvc Class Reference

SqliteReadSvc implementats IRDBAccessSvc interface for reading plain tables in the Geometry SQLite database. More...

#include <SqliteReadSvc.h>

Inheritance diagram for SqliteReadSvc:

Collaboration diagram for SqliteReadSvc:

Public Member Functions
	SqliteReadSvc (const std::string &name, ISvcLocator *svc)
	Standard Service Constructor. More...
StatusCode	finalize () override
StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface) override
bool	connect (const std::string &connName) override
	Open the SQLite database This method has no effect if the connection has already been opened. More...
bool	disconnect (const std::string &) override
	Dummy overrider of the virtual function. More...
bool	shutdown (const std::string &) override
	Closes the database connection. More...
IRDBRecordset_ptr	getRecordsetPtr (const std::string &node, const std::string &, const std::string &, const std::string &) override
	Provides access to the Recordset object containing HVS-tagged data. More...
std::string	getChildTag (const std::string &childNode, const std::string &, const std::string &, const std::string &) override
	Dummy overrider of the virtual function. More...
std::unique_ptr< IRDBQuery >	getQuery (const std::string &node, const std::string &, const std::string &, const std::string &) override
	Dummy overrider of the virtual function (for now) More...
void	getTagDetails (RDBTagDetails &tagDetails, const std::string &tag, const std::string &) override
	Dummy overrider of the virtual function. More...
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Retrieve interface ID. More...

Private Attributes
RecordsetPtrMap	m_recordsets
sqlite3 *	m_db {nullptr}
std::mutex	m_recordsetMutex
std::mutex	m_sessionMutex

Friends
class	SvcFactory< SqliteReadSvc >

Detailed Description

SqliteReadSvc implementats IRDBAccessSvc interface for reading plain tables in the Geometry SQLite database.

Definition at line 40 of file SqliteReadSvc.h.

Constructor & Destructor Documentation

SqliteReadSvc()

SqliteReadSvc::SqliteReadSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Standard Service Constructor.

Definition at line 19 of file SqliteReadSvc.cxx.

  : AthService(name,svc)
{
}

Member Function Documentation

connect()

bool SqliteReadSvc::connect ( const std::string &  connName )

overridevirtual

Open the SQLite database This method has no effect if the connection has already been opened.

Parameters

connName

[IN] path to the SQLite database file

Returns

success/failure

Implements IRDBAccessSvc.

Definition at line 45 of file SqliteReadSvc.cxx.

{
  std::lock_guard<std::mutex> guard(m_sessionMutex);
  if(!m_db) {
    int res = sqlite3_open(connName.c_str(), &m_db);
    if (res != SQLITE_OK) {
      ATH_MSG_FATAL("Failed to open " << connName << ". " << sqlite3_errmsg(m_db));
      return false;
    }
  }
  return true;
}

disconnect()

bool SqliteReadSvc::disconnect ( const std::string &  )

overridevirtual

Dummy overrider of the virtual function.

Returns

success/failure

Implements IRDBAccessSvc.

Definition at line 58 of file SqliteReadSvc.cxx.

{
  // Dummy implementation
  return true;
}

finalize()

StatusCode SqliteReadSvc::finalize ( )

override

Definition at line 24 of file SqliteReadSvc.cxx.

{
  m_recordsets.clear();
  shutdown("");
 
  return StatusCode::SUCCESS;
}

getChildTag()

std::string SqliteReadSvc::getChildTag ( const std::string &  childNode, const std::string &  parentTag, const std::string &  parentNode, const std::string &    )

overridevirtual

Dummy overrider of the virtual function.

Parameters

childNode

[IN] the name of the table

Returns

the name of the table if exists, otherwise an empty string

Implements IRDBAccessSvc.

Definition at line 112 of file SqliteReadSvc.cxx.

{
  ATH_MSG_DEBUG("getChildTag for " << childNode << " " << parentTag << " " << parentNode);
  ATH_MSG_WARNING("SqliteReadSvc::getChildTag is a dummy method");
  return std::string();
}

getQuery()

std::unique_ptr< IRDBQuery > SqliteReadSvc::getQuery ( const std::string &  node, const std::string &  tag, const std::string &  tag2node, const std::string &  connName  )

overridevirtual

Dummy overrider of the virtual function (for now)

Implements IRDBAccessSvc.

Definition at line 101 of file SqliteReadSvc.cxx.

{
  ATH_MSG_DEBUG("getQuery (" << node << "," << tag << "," << tag2node << "," << connName << ")");
  ATH_MSG_WARNING("SqliteReadSvc::getQuery is a dummy method");
 
  return std::unique_ptr<IRDBQuery>();
}

getRecordsetPtr()

IRDBRecordset_ptr SqliteReadSvc::getRecordsetPtr ( const std::string &  node, const std::string &  , const std::string &  , const std::string &    )

overridevirtual

Provides access to the Recordset object containing HVS-tagged data.

Parameters

node	[IN] name of the table. Other input parameters are dummy

Returns

pointer to the recordset object

Implements IRDBAccessSvc.

Definition at line 75 of file SqliteReadSvc.cxx.

{
  ATH_MSG_DEBUG("Getting RecordsetPtr with key " << node);
 
  std::lock_guard<std::mutex> guard(m_recordsetMutex);
  if(!m_db) {
    ATH_MSG_ERROR("Connection to the SQLite database not open. Returning empty recordset");
    return IRDBRecordset_ptr(new SqliteRecordset());
  }
 
  auto itRecordset = m_recordsets.find(node);
  if(itRecordset!=m_recordsets.end()) {
    ATH_MSG_DEBUG("Reusing an existing recordset");
    return itRecordset->second;
  }
 
  SqliteRecordset* recConcrete = new SqliteRecordset();
  recConcrete->getData(m_db,node);
  IRDBRecordset_ptr rec(recConcrete);
  m_recordsets.emplace(node,rec);
  return rec;
}

getTagDetails()

void SqliteReadSvc::getTagDetails ( RDBTagDetails &  tagDetails, const std::string &  tag, const std::string &    )

overridevirtual

Dummy overrider of the virtual function.

Implements IRDBAccessSvc.

Definition at line 122 of file SqliteReadSvc.cxx.

{
  ATH_MSG_DEBUG("getTagDetails for tag: " << tag);
  ATH_MSG_WARNING("SqliteReadSvc::getTagDetails is a dummy method");
  return;
}

interfaceID()

static const InterfaceID& SqliteReadSvc::interfaceID ( )

inlinestatic

Retrieve interface ID.

Definition at line 52 of file SqliteReadSvc.h.

{ return IID_IRDBAccessSvc; }

msg() [1/2]

MsgStream& AthCommonMsg< Service >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< Service >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

bool AthCommonMsg< Service >::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

queryInterface()

StatusCode SqliteReadSvc::queryInterface ( const InterfaceID &  riid, void **  ppvInterface  )

override

Definition at line 32 of file SqliteReadSvc.cxx.

{
  if (IID_IRDBAccessSvc == riid) {
    *ppvInterface = (IRDBAccessSvc*)this;
  }
  else { 
    return AthService::queryInterface(riid, ppvInterface);
  }
 
  addRef();
  return StatusCode::SUCCESS;
}

shutdown()

bool SqliteReadSvc::shutdown ( const std::string &  )

overridevirtual

Closes the database connection.

Returns

success/failure

Implements IRDBAccessSvc.

Definition at line 64 of file SqliteReadSvc.cxx.

{
  std::lock_guard<std::mutex> guard(m_sessionMutex);
  if(m_db) {
    sqlite3_close(m_db);
    m_db = nullptr;
  }
  return true;
}

Friends And Related Function Documentation

SvcFactory< SqliteReadSvc >

friend class SvcFactory< SqliteReadSvc >

friend

Definition at line 47 of file SqliteReadSvc.h.

Member Data Documentation

m_db

sqlite3* SqliteReadSvc::m_db {nullptr}

private

Definition at line 97 of file SqliteReadSvc.h.

m_recordsetMutex

std::mutex SqliteReadSvc::m_recordsetMutex

private

Definition at line 98 of file SqliteReadSvc.h.

m_recordsets

RecordsetPtrMap SqliteReadSvc::m_recordsets

private

Definition at line 96 of file SqliteReadSvc.h.

m_sessionMutex

std::mutex SqliteReadSvc::m_sessionMutex

private

Definition at line 99 of file SqliteReadSvc.h.

---

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

• SqliteReadSvc.h
• SqliteReadSvc.cxx