Dbi.cxx

Go to the documentation of this file.

// $Id: Dbi.cxx,v 1.46 2007/04/26 14:19:57 west Exp $
//
// Dbi
//
// N. West 12/2000
//
// Purpose: Dbi consists entirely of static data and member functions
//          used for package interface.
// 
// General Remarks about Dbi
// =========================
// 
// This primary purposes of this package are:-
//
//  o  To test out ideas.
//
//  o  To serve as an interim DBI for CalDet in 2001..
// 
// Internal Structure
// ==================
//
//  Layered as follows, Higher levels can call those in lower levels
//  Names on the same layer cannot call each other.  The Dbi prefix
//  is omitted on all but Dbi itself.
//  
//  Validate
//  ConfigStream
//  Writer
//  LogEntry
//  ResultPtr
//  SqlValPacket
//  ValRecSet
//  TableProxyRegistry
//  TableProxy
//  ResultAgg
//  ValidityRecBuilder
//  ResultNonAgg
//  Cache  DBProxy
//  Result
//  Record
//  ResultKey
//  ConfigSet ValidityRec  DemoData1  DemoData2 DemoData3
//  BinaryFile
//  TableRow
//  ResultSet OutRowStream
//  RowStream
//  ConnectionMaintainer
//  Cascader
//  SimFlagAssociation
//  Statement
//  Connection
//  TableMetaData
//  RollbackDates FieldType
//  Dbi String Services
//  DbiAsciiDbImporter
//  DbiAsciiTablePreparer
//  ExceptionLog
//  Exception
//  

#include <stdio.h>
#include <sstream>

#include "TList.h"

#include "Conventions/Detector.h"
#include "Conventions/SimFlag.h"
#include "MessageService/MsgService.h"
#include "DatabaseInterface/Dbi.h"
#include "DatabaseInterface/DbiException.h"
#include "DatabaseInterface/DbiExceptionLog.h"


//   Definition of static data members
//   *********************************

CVSID("$Id: Dbi.cxx,v 1.46 2007/04/26 14:19:57 west Exp $");

static std::map<std::string,Int_t> fgTimegateTable;

// Definition of member functions (alphabetical order)
// ***************************************************

//.....................................................................

Int_t Dbi::GetTimeGate(const std::string& tableName) {

//  Purpose: Get a suitable time gate for table.

//  Program Notes:-
//  =============

//  A time gate is applied to all primary (validity) queries to save time
//  and ensure that gaps are not missed. Ideally the gate needs to be 
//  of order of a typical validity range.  Much longer and unneeded
//  VLD records are processed, much shorter and the query results will
//  expire too soon.  Both increase I/O.
//  
//  The system provides a default for each table and DbiValidityRecBuilder
//  updates it if grossly wrong.

  // Set default if looking up table for the first time.
  std::map<std::string,Int_t>::iterator 
      tablePtr = fgTimegateTable.find(tableName);
  if ( tablePtr == fgTimegateTable.end() 
     ) Dbi::SetTimeGate(tableName,10*24*60*60);

  MSG("Dbi",Msg::kDebug) << "Returning time gate " << fgTimegateTable[tableName] 
                          << " for " << tableName << endl;
  return fgTimegateTable[tableName];

}

//.....................................................................

std::string Dbi::GetVldDescr(const char* tableName,
                             Bool_t isTemporary /*= false*/) {
//
//
//  Purpose:  Return string "create [temporary] table tableNameXXX" to make table xxxVLD
//
//  Program Notes:-
//  =============

//  If the format of Validity Tables is changed then this function must
//  be updated as that format is hardwired into an SQL CREATE TABLE
//  command in this function.

  string sql;
  sql += "create ";
  if ( isTemporary ) sql += "temporary ";
  sql += "table ";
  sql += tableName;
  sql += "VLD ( ";
  sql += "  SEQNO integer not null primary key,";
  sql += "  TIMESTART datetime not null,";
  sql += "  TIMEEND datetime not null,";
  sql += "  DETECTORMASK tinyint,";
  sql += "  SIMMASK tinyint,";
  sql += "  TASK integer,";
  sql += "  AGGREGATENO integer,";
  sql += "  CREATIONDATE datetime not null,";
  sql += "  INSERTDATE datetime not null ) ";
  return sql;
}

//.....................................................................

string Dbi::MakeDateTimeString(const VldTimeStamp& timeStamp) {
//
//
//  Purpose: Convert VldTimeStamp to SQL DateTime string.
//
//  Arguments: 
//    timeStamp    in    VldTimeStamp to be converted.
//
//  Return: SQL DateTime string corresponding to VldTimeStamp.   
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Return SQL DateTime string corresponding to VldTimeStamp.

//  Program Notes:-
//  =============

//  The format of a  SQL DateTime string is:-
// 
//            YYYY-MM-DD HH:MM:SS
//    e.g.    2001-01-03 00:00:00
//            0123456789012345678901234567890123"

 return timeStamp.AsString("s");                                               

}
//.....................................................................

VldTimeStamp Dbi::MakeTimeStamp(const std::string& sqlDateTime,
                                Bool_t* ok) {
//
//
//  Purpose:  Convert SQL DateTime string to VldTimeStamp.
//
//  Arguments: 
//    sqlDateTime  in   SQL DateTime string to be convered.
//    ok           in    Optional return flag
//                       If not supplied, report illegal dates
//
//  Return:  VldTimeStamp corresponding to SQL DateTime string.  
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Return VldTimeStamp corresponding to SQL DateTime string.

//  Program Notes:-
//  =============

//  Note that there is only white space between day and hour
//  so no need for dummy separator.

  struct date {
    int year;
    int month;
    int day;
    int hour;
    int min;
    int sec;};
  char dummy;

  static string lo = "1970-01-01 00:00:00";
  static string hi = "2038-01-19 03:14:07";

  // Set up defaults from 0:0am today.
  VldTimeStamp nowTS;
  int nowDate = nowTS.GetDate();
  date defaultDate = {nowDate/10000, nowDate/100%100, nowDate%100,0,0,0};
  date input       = defaultDate;

  istringstream in(sqlDateTime);
  in >> input.year >> dummy >> input.month >> dummy >> input.day 
     >> input.hour >> dummy >> input.min   >> dummy >> input.sec;

  if ( ok ) *ok = kTRUE;
  if (  sqlDateTime < lo || sqlDateTime > hi ) {
    if ( ok ) *ok = kFALSE;
    else {  
      static int bad_date_count = 0;
      if ( ++bad_date_count <= 20 ) {
        const char* last = (bad_date_count == 20) ? "..Last Message.. " : "";
        MSG("Dbi",Msg::kError) 
                            << "Bad date string: " << sqlDateTime
                            << " parsed as "
                            << input.year  << " "
                            << input.month << " "
                            << input.day   << " "
                            << input.hour  << " "
                            << input.min   << " "
                            << input.sec   
                            << "\n    Outside range " << lo 
                            << " to " << hi << last << endl;
      }
    }

    input = defaultDate;
  }

  return VldTimeStamp(input.year,input.month,input.day,
                      input.hour,input.min,input.sec);

}
//.....................................................................

Bool_t Dbi::NotGlobalSeqNo(UInt_t seqNo) { 
  return seqNo <= kMAXLOCALSEQNO; 
}


//.....................................................................

void Dbi::SetLogLevel(int level) {
//
//
//  Purpose:  Set MessageService log level for package.
//
//  Arguments: 
//    level        in    Log level. 
//
//  Return:    None.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Set MessageService log level for package.

//  Program Notes:-
//  =============

//  None.

  MsgService::Instance()->GetStream("Dbi")->SetLogLevel(level);

}

//.....................................................................

void Dbi::SetTimeGate(const std::string& tableName, Int_t timeGate) {

//  Purpose: Set a time gate for table.

//  Program Notes:  See GetTimeGate.

  if ( timeGate > 15 && timeGate <= 100*24*60*60 ) {
    fgTimegateTable[tableName] = timeGate;
    MSG("Dbi",Msg::kDebug) << "Setting time gate " << timeGate
                            << " for " << tableName << endl;
  }
  else {
    MSG("Dbi",Msg::kWarning) << "Ignoring  invalid time gate setting " << timeGate
                             << " for " << tableName << endl;
  }
}

// ********************************************************************

/*    Template for New Member Function

//.....................................................................

Dbi:: {
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o 

//  Program Notes:-
//  =============

//  None.


}

*/

---