TDbi Namespace Reference

Typedefs
typedef Int_t	Task
	Concept Package-wide namespace of utilities and typedef/enums.
Enumerations
enum	TaskTypes { kAnyTask = -1, kDefaultTask = 0 }
enum	TypeRegimes { kRootRegime = 0, kSQLRegime = 1 }
enum	DataTypes {   kUnknown, kBool, kChar, kUChar,   kTiny, kUTiny, kShort, kUShort,   kInt, kUInt, kLong, kULong,   kFloat, kDouble, kString, kTString,   kDate }
enum	DbTypes { kMySQL = 0 }
enum	AbortTest { kDisabled, kTableMissing, kDataMissing }
enum	{ kMAXLOCALSEQNO = 99999999, kMAXTABLENAMELEN = 80 }
Functions
std::string	GetVldDescr (const char *tableName, Bool_t isTemporary=false)
void	SetLogLevel (int level)
	> Return SQL needed to create VLD table.
Int_t	GetTimeGate (const std::string &tableName)
	Time gates for each table in secs. Used to trim validity searches.
void	SetTimeGate (const std::string &tableName, Int_t timeGate)
std::string	MakeDateTimeString (const TVldTimeStamp &timeStamp)
	DateTime conversion utilities.
TVldTimeStamp	MakeTimeStamp (const std::string &sqlDateTime, Bool_t *ok=0)
Bool_t	NotGlobalSeqNo (UInt_t seqNo)
	SeqNo utilities.

---

Typedef Documentation

typedef Int_t TDbi::Task

Concept Package-wide namespace of utilities and typedef/enums.

Purpose To provide standard of utilities and typedef/enums.

Contact: A.Finch@lancaster.ac.uk

Definition at line 40 of file TDbi.hxx.

---

Enumeration Type Documentation

anonymous enum

Enumerator:

kMAXLOCALSEQNO
kMAXTABLENAMELEN

Definition at line 78 of file TDbi.hxx.

       { kMAXLOCALSEQNO   = 99999999,    // Max local SeqNo.
         kMAXTABLENAMELEN = 80};         // Max length of table name.

enum TDbi::AbortTest

Enumerator:

kDisabled
kTableMissing
kDataMissing

Definition at line 73 of file TDbi.hxx.

               { kDisabled,
                 kTableMissing,
                 kDataMissing
 };

enum TDbi::DataTypes

Enumerator:

kUnknown
kBool
kChar
kUChar
kTiny
kUTiny
kShort
kUShort
kInt
kUInt
kLong
kULong
kFloat
kDouble
kString
kTString
kDate

Definition at line 50 of file TDbi.hxx.

               { kUnknown,
                 kBool,      // concept
                 kChar,      // concept
                 kUChar,     // concept
                 kTiny,
                 kUTiny,
                 kShort,
                 kUShort,
                 kInt,       // concept
                 kUInt,      // concept
                 kLong,
                 kULong,
                 kFloat,     // concept
                 kDouble,
                 kString,    // concept
                 kTString,
                 kDate       // concept
 };

enum TDbi::DbTypes

Enumerator:

kMySQL

Definition at line 70 of file TDbi.hxx.

             {  kMySQL         = 0
 };

enum TDbi::TaskTypes

Enumerator:

kAnyTask
kDefaultTask

Definition at line 42 of file TDbi.hxx.

               {  kAnyTask     = -1,   // Use to disable task selection in context queries.
                  kDefaultTask = 0
 };

enum TDbi::TypeRegimes

Enumerator:

kRootRegime
kSQLRegime

Definition at line 46 of file TDbi.hxx.

                 { kRootRegime = 0,
                   kSQLRegime  = 1
};

---

Function Documentation

Int_t TDbi::GetTimeGate

(

const std::string &

tableName

)

Time gates for each table in secs. Used to trim validity searches.

Definition at line 89 of file TDbi.cxx.

References fgTimegateTable, SetTimeGate(), and SK_DBI_Debug.

Referenced by ClassImp(), TDbiDBProxy::FindTimeBoundaries(), TDbiValidityRecBuilder::MakeGapRec(), and TDbiDBProxy::QueryValidity().

                                                  {

//  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 TDbiValidityRecBuilder
//  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()
     ) TDbi::SetTimeGate(tableName,10*24*60*60);

  SK_DBI_Debug( "Returning time gate " << fgTimegateTable[tableName]
                          << " for " << tableName << "  ");
  return fgTimegateTable[tableName];

}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string TDbi::GetVldDescr	(	const char *	tableName,
		Bool_t	isTemporary = false
	)

Definition at line 119 of file TDbi.cxx.

Referenced by TDbiCascader::CreateTemporaryTable().

                                                             {
//
//
//  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 += "  EPOCH tinyint,";
  sql += "  REALITY tinyint,";
  sql += "  DETECTORMASK tinyint,";
  sql += "  SIMMASK tinyint,";
  sql += "  TASK integer,";
  sql += "  AGGREGATENO integer,";
  sql += "  CREATIONDATE datetime not null,";
  sql += "  INSERTDATE datetime not null ) ";
  return sql;
}

Here is the caller graph for this function:

string TDbi::MakeDateTimeString

(

const TVldTimeStamp &

timeStamp

)

DateTime conversion utilities.

Definition at line 154 of file TDbi.cxx.

References TVldTimeStamp::AsString().

Referenced by TDbiDBProxy::FindTimeBoundaries(), TDbiOutRowStream::operator<<(), TDbiDBProxy::QueryValidity(), TDbiRollbackDates::Set(), TDbiSqlValPacket::Store(), and UnixTimeToDateTime().

                                                              {
//
//
//  Purpose: Convert TVldTimeStamp to SQL DateTime string.
//
//  Arguments:
//    timeStamp    in    TVldTimeStamp to be converted.
//
//  Return: SQL DateTime string corresponding to TVldTimeStamp.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Return SQL DateTime string corresponding to TVldTimeStamp.

//  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");

}

Here is the call graph for this function:

Here is the caller graph for this function:

TVldTimeStamp TDbi::MakeTimeStamp	(	const std::string &	sqlDateTime,
		Bool_t *	ok = 0
	)

Definition at line 185 of file TDbi.cxx.

References TVldTimeStamp::GetDate(), and SK_DBI_Severe.

Referenced by DateTimeToUnixTime(), TDbiDBProxy::FindTimeBoundaries(), TDbiInRowStream::operator>>(), and TDbiRollbackDates::Set().

                                            {
//
//
//  Purpose:  Convert SQL DateTime string to TVldTimeStamp.
//
//  Arguments:
//    sqlDateTime  in   SQL DateTime string to be convered.
//    ok           in    Optional return flag
//                       If not supplied, report illegal dates
//
//  Return:  TVldTimeStamp corresponding to SQL DateTime string.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Return TVldTimeStamp 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.
  TVldTimeStamp 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.. " : "";
        SK_DBI_Severe(  "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 << "  ");
      }
    }

    input = defaultDate;
  }

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

}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbi::NotGlobalSeqNo

(

UInt_t

seqNo

)

SeqNo utilities.

Definition at line 262 of file TDbi.cxx.

References kMAXLOCALSEQNO.

                                        {
  return seqNo <= kMAXLOCALSEQNO;
}

void TDbi::SetLogLevel

(

int

level

)

> Return SQL needed to create VLD table.

Definition at line 269 of file TDbi.cxx.

                                {
//
//
//  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.



}

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

Definition at line 297 of file TDbi.cxx.

References fgTimegateTable, SK_DBI_Debug, and SK_DBI_Warn.

Referenced by ClassImp(), and GetTimeGate().

                                                                 {

//  Purpose: Set a time gate for table.

//  Program Notes:  See GetTimeGate.

  if ( timeGate > 15 && timeGate <= 100*24*60*60 ) {
    fgTimegateTable[tableName] = timeGate;
    SK_DBI_Debug( "Setting time gate " << timeGate
                            << " for " << tableName << "  ");
  }
  else {
    SK_DBI_Warn( "Ignoring  invalid time gate setting " << timeGate
                             << " for " << tableName << "  ");
  }
}

Here is the caller graph for this function: