TrigConf::TrigDBMenuLoader Class Reference

Loader of trigger menu configurations from the database. More...

#include <TrigDBMenuLoader.h>

Inheritance diagram for TrigConf::TrigDBMenuLoader:

Collaboration diagram for TrigConf::TrigDBMenuLoader:

Public Member Functions
	TrigDBMenuLoader (const std::string &connection)
	Constructor. More...
virtual	~TrigDBMenuLoader () override
	Destructor - cannot be defined here because QueryDefinition is an incomplete type. More...
bool	loadL1Menu (unsigned int smk, boost::property_tree::ptree &l1menu, const std::string &outFileName="") const
	Load L1 menu content from the Trigger DB into a ptree for a given SuperMasterKey (SMK) More...
bool	loadHLTMenu (unsigned int smk, boost::property_tree::ptree &hltmenu, const std::string &outFileName="") const
	Load HLT menu content from the Trigger DB into two ptrees for a given SuperMasterKey (SMK) More...
bool	loadL1Menu (unsigned int smk, L1Menu &l1menu, const std::string &outFileName="") const
	Load content from the Trigger DB into an L1Menu for a given SuperMasterKey (SMK) More...
bool	loadHLTMenu (unsigned int smk, HLTMenu &hltmenu, const std::string &outFileName="") const
	Load content from the Trigger DB into an HLTMenu for a given SuperMasterKey (SMK) More...
size_t	schemaVersion (coral::ISessionProxy *session) const
	access to TriggerDB schema version More...
bool	writeRawFile (const coral::Blob &data, const std::string &outFileName) const
	write data blob into file This can be used to write the DB content to file without going through a ptree More...
void	setLevel (MSGTC::Level lvl)
MSGTC::Level	outputLevel () const
bool	msgLvl (const MSGTC::Level lvl) const
	Test the output level. More...
MsgStreamTC &	msg () const
	The standard message stream. More...
MsgStreamTC &	msg (const MSGTC::Level lvl) const
	The standard message stream. More...

Protected Member Functions
std::unique_ptr< coral::ISessionProxy >	createDBSession () const
	create (if needed) DB session and return the session proxy More...
QueryDefinition	getQueryDefinition (size_t schemaVersion, const std::map< size_t, QueryDefinition > &queries) const
	return query for given schemaVersion from possible queries More...

Private Attributes
std::map< size_t, QueryDefinition >	m_l1queries
std::map< size_t, QueryDefinition >	m_hltqueries
std::string	m_connection {"TRIGGERDB"}
int	m_retrialPeriod {0}
int	m_retrialTimeout {0}
int	m_connectionTimeout {0}
boost::thread_specific_ptr< MsgStreamTC >	m_msg_tls
	MsgStreamTC instance (a std::cout like with print-out levels) More...
std::string	m_name

Detailed Description

Loader of trigger menu configurations from the database.

Definition at line 30 of file TrigDBMenuLoader.h.

Constructor & Destructor Documentation

TrigDBMenuLoader()

TrigConf::TrigDBMenuLoader::TrigDBMenuLoader

(

const std::string &

connection

)

Constructor.

Definition at line 6 of file TrigDBMenuLoader.cxx.

                                                                       : 
   TrigDBLoader("TrigDBMenuLoader", connection)
{
   /*
     L1 menu queries
   */
   { // for schema version 1
      auto & q = m_l1queries[1];
      // tables
      q.addToTableList ( "SUPER_MASTER_TABLE", "SMT" );
      q.addToTableList ( "L1_MASTER_TABLE", "L1MT" );
      // bind vars
      q.extendBinding<int>("smk");
      // conditions
      q.extendCondition("SMT.SMT_ID = :smk");
      q.extendCondition(" AND SMT.SMT_L1_MASTER_TABLE_ID = L1MT.L1MT_ID");
      // attributes
      q.extendOutput<std::string>( "SMT.SMT_NAME" );
      q.extendOutput<int>        ( "SMT.SMT_L1_MASTER_TABLE_ID" );
      q.extendOutput<coral::Blob>( "L1MT.L1MT_MENU" );
      // the field with the data
      q.setDataName("L1MT.L1MT_MENU");
   }
   { // for schema version 2
      auto & q = m_l1queries[2];
      // tables
      q.addToTableList ( "SUPER_MASTER_TABLE", "SMT" );
      q.addToTableList ( "L1_MENU", "L1TM" );
      // bind vars
      q.extendBinding<int>("smk");
      // conditions
      q.extendCondition("SMT.SMT_ID = :smk");
      q.extendCondition(" AND SMT.SMT_L1_MENU_ID = L1TM.L1TM_ID");
      // attributes
      q.extendOutput<std::string>( "SMT.SMT_NAME" );
      q.extendOutput<int>        ( "SMT.SMT_VERSION" );
         q.extendOutput<int>        ( "SMT.SMT_L1_MENU_ID" );
         q.extendOutput<coral::Blob>( "L1TM.L1TM_DATA" );
         // the field with the data
         q.setDataName("L1TM.L1TM_DATA");
   }
 
   /*
     HLT menu queries
   */
   { // for schema version 1
      auto & q = m_hltqueries[1];
      // tables
      q.addToTableList ( "SUPER_MASTER_TABLE", "SMT" );
      q.addToTableList ( "HLT_MASTER_TABLE", "HMT" );
      // bind vars
      q.extendBinding<int>("smk");
      // conditions
      q.extendCondition("SMT.SMT_ID = :smk");
      q.extendCondition(" AND SMT.SMT_HLT_MASTER_TABLE_ID = HMT.HMT_ID");
      // attributes
      q.extendOutput<std::string>( "SMT.SMT_NAME" );
      q.extendOutput<int>        ( "SMT.SMT_HLT_MASTER_TABLE_ID" );
      q.extendOutput<coral::Blob>( "HMT.HMT_MENU" );
      // the field with the data
      q.setDataName("HMT.HMT_MENU");
   }
   { // for schema version 2
      auto & q = m_hltqueries[2];
      // tables
      q.addToTableList ( "SUPER_MASTER_TABLE", "SMT" );
      q.addToTableList ( "HLT_MENU", "HTM" );
      // bind vars
      q.extendBinding<int>("smk");
      // conditions
      q.extendCondition("SMT.SMT_ID = :smk");
      q.extendCondition(" AND SMT.SMT_HLT_MENU_ID = HTM.HTM_ID");
      // attributes
      q.extendOutput<std::string>( "SMT.SMT_NAME" );
      q.extendOutput<int>        ( "SMT.SMT_VERSION" );
      q.extendOutput<int>        ( "SMT.SMT_HLT_MENU_ID" );
      q.extendOutput<coral::Blob>( "HTM.HTM_DATA" );
      // the field with the data
      q.setDataName("HTM.HTM_DATA");
   }
}

~TrigDBMenuLoader()

TrigConf::TrigDBMenuLoader::~TrigDBMenuLoader ( )

overridevirtualdefault

Destructor - cannot be defined here because QueryDefinition is an incomplete type.

Member Function Documentation

createDBSession()

std::unique_ptr< coral::ISessionProxy > TrigConf::TrigDBLoader::createDBSession ( ) const

protectedinherited

create (if needed) DB session and return the session proxy

Definition at line 94 of file TrigDBLoader.cxx.

                                            {
 
   coral::ConnectionService connSvc;
   coral::IConnectionServiceConfiguration& csc = connSvc.configuration();
   csc.setConnectionRetrialPeriod( m_retrialPeriod );
   csc.setConnectionRetrialTimeOut( m_retrialTimeout );
   csc.setConnectionTimeOut( m_connectionTimeout );
 
   /* TODO
   if(csc.replicaSortingAlgorithm() == nullptr) { // likely to be standalone, create our own
      TRG_MSG_INFO("Create own ReplicaSortingAlgorithm");
      m_replicaSorter = new TrigConf::ReplicaSorter();
      csc.setReplicaSortingAlgorithm(*m_replicaSorter);
   }
   */
 
   TRG_MSG_INFO("Connecting to " << m_connection);
 
   auto proxy = std::unique_ptr<coral::ISessionProxy>( connSvc.connect(m_connection, coral::AccessMode::ReadOnly) );
 
   TRG_MSG_INFO("Opened session " << m_connection << " with  retrialPeriod/retrialTimeout/connectionTimeout: " 
                << m_retrialPeriod << "/" << m_retrialTimeout << "/" << m_connectionTimeout);
 
   return proxy;
}

getQueryDefinition()

TrigConf::QueryDefinition TrigConf::TrigDBLoader::getQueryDefinition ( size_t  schemaVersion, const std::map< size_t, QueryDefinition > &  queries  ) const

protectedinherited

return query for given schemaVersion from possible queries

Definition at line 122 of file TrigDBLoader.cxx.

{
   // find the largest version key in the map of defined queries that is <= the schemaVersion
   size_t maxDefVersion = 0;
   for(auto & entry : queries) {
      size_t vkey = entry.first;
      if(vkey>maxDefVersion and vkey<=schemaVersion) {
         maxDefVersion = vkey;
      }
   }
   // if nothing found, throw an error
   if( maxDefVersion==0 ) {
      TRG_MSG_ERROR("No query for schema version " << schemaVersion << " defined" );
      throw TrigConf::NoQueryException( "No query available for schema version" + std::to_string(schemaVersion) );
   }
   return queries.at(maxDefVersion);
}

loadHLTMenu() [1/2]

bool TrigConf::TrigDBMenuLoader::loadHLTMenu	(	unsigned int	smk,
		boost::property_tree::ptree &	hltmenu,
		const std::string &	outFileName = ""
	)		const

Load HLT menu content from the Trigger DB into two ptrees for a given SuperMasterKey (SMK)

Parameters

smk	[in] the SMK that should be loaded
hltmenu	[out] the loaded HLT menu

Returns

true if loading was successfull

Definition at line 123 of file TrigDBMenuLoader.cxx.

{
   auto session = createDBSession();
   session->transaction().start( /*bool readonly=*/ true);
   const size_t sv = schemaVersion(session.get());
   QueryDefinition qdef = getQueryDefinition(sv, m_hltqueries);
   try {
      qdef.setBoundValue<int>("smk", smk);
      auto q = qdef.createQuery( session.get() );
      auto & cursor = q->execute();
      if ( ! cursor.next() ) {
         TRG_MSG_ERROR("Tried reading HLT menu, but SuperMasterKey " << smk << " is not available" );
         throw TrigConf::NoSMKException("TrigDBMenuLoader (HLTMenu): SMK " + std::to_string(smk) + " not available");
      }
      const coral::AttributeList& row = cursor.currentRow();
      const coral::Blob& dataBlob = row[qdef.dataName()].data<coral::Blob>();
      writeRawFile( dataBlob, outFileName );
      blobToPtree( dataBlob, hltmenu );
   }
   catch(coral::QueryException & ex) {
      TRG_MSG_ERROR("When reading HLT menu for SMK " << smk << " a coral::QueryException was caught ( " << ex.what() <<" )" );
      throw TrigConf::QueryException("TrigDBMenuLoader (HLTMenu): " + std::string(ex.what()));
   }
   return true;
}

loadHLTMenu() [2/2]

bool TrigConf::TrigDBMenuLoader::loadHLTMenu	(	unsigned int	smk,
		HLTMenu &	hltmenu,
		const std::string &	outFileName = ""
	)		const

Load content from the Trigger DB into an HLTMenu for a given SuperMasterKey (SMK)

Parameters

smk	[in] the SMK that should be loaded
hltmenu	[out] the loaded HLT menu
outFileName	[in] if set, an outputfile with the raw data blob is written

Returns

true if loading was successfull

Definition at line 172 of file TrigDBMenuLoader.cxx.

{
   boost::property_tree::ptree pthlt;
   loadHLTMenu( smk, pthlt, outFileName );
   try {
      hltmenu.setData(std::move(pthlt));
      hltmenu.setSMK(smk);
   }
   catch(std::exception & ex) {
      hltmenu.clear();
      TRG_MSG_ERROR("When reading HLT menu for SMK " << smk << " a parsing error occured ( " << ex.what() <<" )" );
      throw TrigConf::ParsingException("TrigDBMenuLoader: parsing error " + std::string(ex.what()));
   }
   return true;
}

loadL1Menu() [1/2]

bool TrigConf::TrigDBMenuLoader::loadL1Menu	(	unsigned int	smk,
		boost::property_tree::ptree &	l1menu,
		const std::string &	outFileName = ""
	)		const

Load L1 menu content from the Trigger DB into a ptree for a given SuperMasterKey (SMK)

Parameters

smk	[in] the SMK that should be loaded
l1menu	[out] the loaded L1 menu

Returns

true if loading was successfull

Definition at line 93 of file TrigDBMenuLoader.cxx.

{
   auto session = createDBSession();
   session->transaction().start( /*bool readonly=*/ true);
   const size_t sv = schemaVersion(session.get());
   QueryDefinition qdef = getQueryDefinition(sv, m_l1queries);
   try {
      qdef.setBoundValue<int>("smk", smk);
      auto q = qdef.createQuery( session.get() );
      auto & cursor = q->execute();
      if ( ! cursor.next() ) {
         TRG_MSG_ERROR("Tried reading L1 menu, but SuperMasterKey " << smk << " is not available" );
         throw TrigConf::NoSMKException("TrigDBMenuLoader (L1Menu): SMK " + std::to_string(smk) + " not available");
      }
      const coral::AttributeList& row = cursor.currentRow();
      const coral::Blob& dataBlob = row[qdef.dataName()].data<coral::Blob>();
      writeRawFile( dataBlob, outFileName );
      blobToPtree( dataBlob, l1menu );
   }
   catch(coral::QueryException & ex) {
      TRG_MSG_ERROR("When reading L1 menu for SMK " << smk << " a coral::QueryException was caught ( " << ex.what() <<" )" );
      throw TrigConf::QueryException("TrigDBMenuLoader (L1Menu): " + std::string(ex.what()));
   }
   return true;
}

loadL1Menu() [2/2]

bool TrigConf::TrigDBMenuLoader::loadL1Menu	(	unsigned int	smk,
		L1Menu &	l1menu,
		const std::string &	outFileName = ""
	)		const

Load content from the Trigger DB into an L1Menu for a given SuperMasterKey (SMK)

Parameters

smk	[in] the SMK that should be loaded
l1menu	[out] the loaded L1 menu
outFileName	[in] if set, an outputfile with the raw data blob is written

Returns

true if loading was successfull

Definition at line 153 of file TrigDBMenuLoader.cxx.

{
   boost::property_tree::ptree ptl1;
   loadL1Menu( smk, ptl1, outFileName );
   try {
      l1menu.setData(std::move(ptl1));
      l1menu.setSMK(smk);
   }
   catch(std::exception & ex) {
      l1menu.clear();
      TRG_MSG_ERROR("When reading L1 menu for SMK " << smk << " a parsing error occured ( " << ex.what() <<" )" );
      throw TrigConf::ParsingException("TrigDBMenuLoader: parsing error " + std::string(ex.what()));
   }
   return true;
}

msg() [1/2]

MsgStreamTC & TrigConf::TrigConfMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 81 of file TrigConfMessaging.h.

  {
    MsgStreamTC* ms = m_msg_tls.get();
    if (!ms) {
      ms = new MsgStreamTC(m_name);
      m_msg_tls.reset(ms);
    }
    return *ms;
  }

msg() [2/2]

MsgStreamTC & TrigConf::TrigConfMessaging::msg ( const MSGTC::Level  lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 91 of file TrigConfMessaging.h.

  {
    return msg() << lvl;
  }

msgLvl()

bool TrigConf::TrigConfMessaging::msgLvl ( const MSGTC::Level  lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicting if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 70 of file TrigConfMessaging.h.

  {
    if (msg().level() <= lvl) {
      msg() << lvl;
      return true;
    }
    else {
      return false;
    }
  }

outputLevel()

MSGTC::Level TrigConf::TrigDBLoader::outputLevel ( ) const

inlineinherited

Definition at line 54 of file TrigDBLoader.h.

{ return msg().level(); }

schemaVersion()

size_t TrigConf::TrigDBLoader::schemaVersion ( coral::ISessionProxy *  session ) const

inherited

access to TriggerDB schema version

Returns

version of the DB schema (0 - no version, >0 - schema version)

Definition at line 38 of file TrigDBLoader.cxx.

                                                                     {
 
   static const std::string versionTagPrefix("Trigger-Run3-Schema-v");
 
   // if database has no schema version, then we return 0
   if(! session->nominalSchema().existsTable("TRIGGER_SCHEMA") ) {
      throw std::runtime_error( "Trigger schema has no schema version table" );
   }
   
   TrigConf::QueryDefinition qdef;
   // tables
   qdef.addToTableList ( "TRIGGER_SCHEMA" );
   // attributes
   qdef.extendOutput<std::string>( "TS_TAG" );
 
   auto query = qdef.createQuery( session );
   auto & cursor = query->execute();
   if ( ! cursor.next() ) {
      throw std::runtime_error( "Trigger schema has schema version table but it is empty" );
   }
 
   const coral::AttributeList& row = cursor.currentRow();
   std::string versionTag = row["TS_TAG"].data<std::string>();
   if( ! startswith(versionTag, versionTagPrefix)) {
      throw std::runtime_error( "Tag format error: Trigger schema version tag " + versionTag + "does not start with " + versionTagPrefix);      
   }
   
   std::string vstr = versionTag.substr(versionTagPrefix.size()); // the part of the string containing the version
   size_t schemaVersion{0};
   try {
      schemaVersion = std::stoi(vstr);
   }
   catch (const std::invalid_argument& ia) {
      TRG_MSG_ERROR("Invalid argument when interpreting the version part " << vstr << " of schema tag " << versionTag << ". " << ia.what());
      throw;
   }
 
   TRG_MSG_INFO("TriggerDB schema version: " << schemaVersion);
   return schemaVersion;
}

setLevel()

void TrigConf::TrigDBLoader::setLevel ( MSGTC::Level  lvl )

inlineinherited

Definition at line 52 of file TrigDBLoader.h.

{ msg().setLevel(lvl); }

writeRawFile()

bool TrigConf::TrigDBLoader::writeRawFile ( const coral::Blob &  data, const std::string &  outFileName  ) const

inherited

write data blob into file This can be used to write the DB content to file without going through a ptree

Definition at line 80 of file TrigDBLoader.cxx.

{
   if( outFileName.empty() ) {
      return true;
   }
   std::ofstream outFile;
   outFile.open( outFileName, std::ofstream::binary );
   outFile.write( static_cast<const char*> ( data.startingAddress()), data.size() );
   outFile.close();
   TRG_MSG_INFO("Wrote file " << outFileName);
   return true;
}

Member Data Documentation

m_connection

std::string TrigConf::TrigDBLoader::m_connection {"TRIGGERDB"}

privateinherited

Definition at line 68 of file TrigDBLoader.h.

m_connectionTimeout

int TrigConf::TrigDBLoader::m_connectionTimeout {0}

privateinherited

Definition at line 71 of file TrigDBLoader.h.

m_hltqueries

std::map<size_t, QueryDefinition> TrigConf::TrigDBMenuLoader::m_hltqueries

private

Definition at line 82 of file TrigDBMenuLoader.h.

m_l1queries

std::map<size_t, QueryDefinition> TrigConf::TrigDBMenuLoader::m_l1queries

private

Definition at line 81 of file TrigDBMenuLoader.h.

m_msg_tls

boost::thread_specific_ptr<MsgStreamTC> TrigConf::TrigConfMessaging::m_msg_tls

mutableprivateinherited

MsgStreamTC instance (a std::cout like with print-out levels)

Definition at line 66 of file TrigConfMessaging.h.

m_name

std::string TrigConf::TrigConfMessaging::m_name

privateinherited

Definition at line 67 of file TrigConfMessaging.h.

m_retrialPeriod

int TrigConf::TrigDBLoader::m_retrialPeriod {0}

privateinherited

Definition at line 69 of file TrigDBLoader.h.

m_retrialTimeout

int TrigConf::TrigDBLoader::m_retrialTimeout {0}

privateinherited

Definition at line 70 of file TrigDBLoader.h.

---

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

• TrigDBMenuLoader.h
• TrigDBMenuLoader.cxx