SqliteRecordset Class Reference

SqliteRecordset implements IRDBRecordset interface. It is a container of records read from an SQLite table. More...

#include <SqliteRecordset.h>

Inheritance diagram for SqliteRecordset:

Collaboration diagram for SqliteRecordset:

Public Types
typedef RecordsVector::const_iterator	const_iterator

Public Member Functions
	SqliteRecordset ()
	Construct empty recordset. More...
void	getData (sqlite3 *db, const std::string &nodeName)
	Constructs SQL query and retrieves data from the DB. More...
unsigned int	size () const override
std::string	nodeName () const override
std::string	tagName () const override
const IRDBRecord *	operator[] (unsigned int index) const override
IRDBRecordset::const_iterator	begin () const override
IRDBRecordset::const_iterator	end () const override
bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...
MsgStream &	msg () const
	The standard message stream. More...
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...
void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
std::string	m_nodeName {}
SqliteInpDef_ptr	m_def
RecordsVector	m_records
std::string	m_nm
	Message source name. More...
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

SqliteRecordset implements IRDBRecordset interface. It is a container of records read from an SQLite table.

Definition at line 30 of file SqliteRecordset.h.

Member Typedef Documentation

const_iterator

typedef RecordsVector::const_iterator IRDBRecordset::const_iterator

inherited

Definition at line 52 of file IRDBRecordset.h.

Constructor & Destructor Documentation

SqliteRecordset()

SqliteRecordset::SqliteRecordset

(

)

Construct empty recordset.

Definition at line 19 of file SqliteRecordset.cxx.

  : AthMessaging("SqliteRecordset")
  , m_def(std::make_shared<SqliteInpDef>())
{
}

Member Function Documentation

begin()

IRDBRecordset::const_iterator SqliteRecordset::begin ( ) const

overridevirtual

Returns

begin iterator

Implements IRDBRecordset.

Definition at line 150 of file SqliteRecordset.cxx.

{
  return m_records.begin();
}

end()

IRDBRecordset::const_iterator SqliteRecordset::end ( ) const

overridevirtual

Returns

end iterator

Implements IRDBRecordset.

Definition at line 155 of file SqliteRecordset.cxx.

{
  return m_records.end();
}

getData()

void SqliteRecordset::getData	(	sqlite3 *	db,
		const std::string &	nodeName
	)

Constructs SQL query and retrieves data from the DB.

Parameters

taginfo

[IN] object holding information about the node tag

Definition at line 25 of file SqliteRecordset.cxx.

{ 
  //the following should already be checked by the calling code and should never happen
  if (db == nullptr){
    throw std::runtime_error("SqliteRecordset::getData : db pointer is null");
  }
  if (nodeName.empty()){
    throw std::runtime_error("SqliteRecordset::getData : nodeName is empty");
  }
  ATH_MSG_DEBUG("getData for " << nodeName);
  m_nodeName = nodeName;
 
  std::ostringstream sql;
 
  // First check if the table exists in the database
  sql << "select * from " << m_nodeName;
  sqlite3_stmt* stTable{nullptr};
  int rc = sqlite3_prepare_v2(db, sql.str().c_str(), -1, &stTable, NULL);
  if(rc!=SQLITE_OK) {
    ATH_MSG_INFO(m_nodeName << " table is not found in the database");
    return;
  }
 
  sql << " order by " << m_nodeName << "_data_id";
  sqlite3_stmt* st{nullptr};
  rc = sqlite3_prepare_v2(db, sql.str().c_str(), -1, &st, NULL);
  if(rc!=SQLITE_OK) {
    ATH_MSG_ERROR("Error occurred when preparing to fetch data for " << m_nodeName);
    ATH_MSG_ERROR("SQLite Error: " << sqlite3_errmsg(db));
    return;
  }
  int ctotal = sqlite3_column_count(st);
 
  bool all_ok{true};
 
  while(true) {
    rc = sqlite3_step(st);
 
    if(rc == SQLITE_ROW) {
      SqliteRecord* rec = new SqliteRecord(m_def);
      IRDBRecord_ptr record{rec};
 
      // Loop throug the fields of the retrieved record
      for(int i=0; i<ctotal; ++i) {
 
    // The feature of SQLite: if in the given record some fields have NULL values,
    // then the data type of the corresponding columns is reported as NULL.
    // This means that we need to be able to build the Def gradually, as we read
    // in new records of the table
    
    // Do we need to extend Def?
    std::string columnName = sqlite3_column_name(st,i);
    bool extendDef = (m_def->find(columnName)==m_def->end());
 
    auto columnType = sqlite3_column_type(st,i);
    SqliteInpType inpType{SQLITEINP_UNDEF};
    SqliteInp val;
 
    switch(columnType) {
    case SQLITE_INTEGER:
      inpType = SQLITEINP_INT;
      val = sqlite3_column_int(st,i);
      break;
    case SQLITE_FLOAT:
      inpType = SQLITEINP_DOUBLE;
      val = sqlite3_column_double(st,i);
      break;
    case SQLITE_TEXT:
      inpType = SQLITEINP_STRING;
      val = std::string((char*)(sqlite3_column_text(st,i)));
      break;
    case SQLITE_BLOB:
      inpType = SQLITEINP_STRING;
      val = std::string((char*)(sqlite3_column_blob(st,i)));
      break;
    case SQLITE_NULL:
      continue;
    default:
      break;
    }
 
    if(inpType==SQLITEINP_UNDEF) {
      all_ok = false;
      ATH_MSG_ERROR("Unexpected data type in column " << columnName << " of the table " << m_nodeName);
      break;
    }
 
    if(extendDef) {
      (*m_def)[columnName] = inpType;
    }
    rec->addValue(columnName,val);
      }
      m_records.push_back(std::move(record));
    }
    else if(rc == SQLITE_DONE) {
      break;
    }
    else {
      ATH_MSG_ERROR("Error occurred when fetching data for " << m_nodeName);
      ATH_MSG_ERROR("SQLite Error: " << sqlite3_errmsg(db));
      all_ok = false;
      break;
    }
  }
 
  if(!all_ok) {
    // Do memory cleanup
    m_records.clear();
  }
}

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  m_lvl = m_imsg ?
    static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
    MSG::INFO;
}

msg() [1/2]

MsgStream & AthMessaging::msg ( ) 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 164 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::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 179 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (!m_initialized.test_and_set()) initMessaging();
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

nodeName()

std::string SqliteRecordset::nodeName ( ) const

overridevirtual

Returns

node name

Implements IRDBRecordset.

Definition at line 141 of file SqliteRecordset.cxx.

{
  return m_nodeName;
}

operator[]()

const IRDBRecord * SqliteRecordset::operator[] ( unsigned int  index ) const

overridevirtual

Parameters

index

[IN] index of the record

Returns

RDBRecord by index

Implements IRDBRecordset.

Definition at line 146 of file SqliteRecordset.cxx.

{
  return m_records[index].get();
}

setLevel()

void AthMessaging::setLevel ( MSG::Level  lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

size()

unsigned int SqliteRecordset::size ( ) const

overridevirtual

Returns

number of records

Implements IRDBRecordset.

Definition at line 136 of file SqliteRecordset.cxx.

{
  return m_records.size();
}

tagName()

std::string SqliteRecordset::tagName ( ) const

inlineoverridevirtual

Returns

tag name

Implements IRDBRecordset.

Definition at line 47 of file SqliteRecordset.h.

{return std::string();}

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_def

SqliteInpDef_ptr SqliteRecordset::m_def

private

Definition at line 61 of file SqliteRecordset.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

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

Definition at line 132 of file AthMessaging.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_nodeName

std::string SqliteRecordset::m_nodeName {}

private

Definition at line 60 of file SqliteRecordset.h.

m_records

RecordsVector SqliteRecordset::m_records

private

Definition at line 62 of file SqliteRecordset.h.

---

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

• SqliteRecordset.h
• SqliteRecordset.cxx