TDbiTableProxy Class Reference

Concept Object to query a specific database table. More...

#include <TDbiTableProxy.hxx>

Collaboration diagram for TDbiTableProxy:

[legend]

List of all members.

Public Member Functions
const TDbiDBProxy &	GetDBProxy () const
TDbiCascader &	GetCascader ()
const TDbiTableMetaData &	GetMetaData () const
const TDbiTableMetaData &	GetMetaValid () const
string	GetRowName () const
string	GetTableName () const
TDbiCache *	GetCache ()
const TDbiResultSet *	Query (const TVldContext &vc, const TDbi::Task &task, Bool_t findFullTimeWindow=true)
const TDbiResultSet *	Query (const string &context, const TDbi::Task &task, const string &data, const string &fillOpts)
const TDbiResultSet *	Query (UInt_t seqNo, UInt_t dbNo)
const TDbiResultSet *	Query (const TDbiValidityRec &vrec, Bool_t canReuse=kTRUE)
TVldTimeStamp	QueryOverlayCreationDate (const TDbiValidityRec &vrec, UInt_t dbNo)
void	RefreshMetaData ()
void	SetSqlCondition (const string &sql)
Bool_t	TableExists () const
Protected Member Functions
	TDbiTableProxy (TDbiCascader *cascader, const string &tableName, const TDbiTableRow *tableRow)
virtual	~TDbiTableProxy ()
Private Member Functions
	TDbiTableProxy (const TDbiTableProxy &)
TDbiTableProxy &	operator= (const TDbiTableProxy &)
Bool_t	CanReadL2Cache () const
	Level 2 (disk) cache management.
Bool_t	CanWriteL2Cache () const
Bool_t	RestoreFromL2Cache (const TDbiValidityRecBuilder &builder)
Bool_t	SaveToL2Cache (const string &name, TDbiResultSet &res)
Private Attributes
TDbiCascader *	fCascader
	Pointer to one and only cascader.
TDbiTableMetaData	fMetaData
	Meta data for main(data) table.
TDbiTableMetaData	fMetaValid
	Meta data for aux. (validity)table.
Bool_t	fCanL2Cache
	True if row supports L2 cache.
TDbiCache *	fCache
	Associated cache for result.
TDbiDBProxy	fDBProxy
	Proxy to database.
Bool_t	fExists
	true if table exists;
string	fTableName
	Table Name.
TDbiTableRow *	fTableRow
	Pet object used to create new rows.
Friends
class	TDbiDatabaseManager

---

Detailed Description

Concept Object to query a specific database table.

Purpose A TDbiTableProxy is an object that knows how to send queries to a specific database table. Internally it uses a cache to minimise I/O. Contact: A.Finch@lancaster.ac.uk

Definition at line 43 of file TDbiTableProxy.hxx.

---

Constructor & Destructor Documentation

TDbiTableProxy::TDbiTableProxy	(	TDbiCascader *	cascader,
		const string &	tableName,
		const TDbiTableRow *	tableRow
	)			[protected]

Constructors (protected because created and owned by TDbiDatabaseManager).

   
     Purpose:  Constructor
   
     Arguments:
                in  cascader   Reference to one and only cascader
                in  tableName  Table name.
                in  tableRow   Example table row object.
   
     Return:    n/a
   
     Contact:   N. West
   
     Specification:-
     =============
   
     o Create table proxy for supplied table name.
   

TDbiTableProxy::~TDbiTableProxy

(

)

[protected, virtual]

Definition at line 89 of file TDbiTableProxy.cxx.

References fCache, fTableName, fTableRow, and SK_DBI_Trace.

                                {
//
//
//  Purpose: Destructor
//
//  Arguments:
//    None.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Destroy object.


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

//  None.


    SK_DBI_Trace( "Destroying TDbiTableProxy "
                            << fTableName << " at " << this
                            << "  ");
  delete fCache;
  delete fTableRow;

}

TDbiTableProxy::TDbiTableProxy

(

const TDbiTableProxy &

)

[private]

---

Member Function Documentation

Bool_t TDbiTableProxy::CanReadL2Cache

(

)

const [private]

Level 2 (disk) cache management.

Definition at line 122 of file TDbiTableProxy.cxx.

References fCanL2Cache.

Referenced by Query(), and RestoreFromL2Cache().

                                            {
//

  return fCanL2Cache && TDbiBinaryFile::CanReadL2Cache();

}

Here is the caller graph for this function:

Bool_t TDbiTableProxy::CanWriteL2Cache

(

)

const [private]

Definition at line 128 of file TDbiTableProxy.cxx.

References fCanL2Cache.

Referenced by SaveToL2Cache().

                                             {
//

  return fCanL2Cache && TDbiBinaryFile::CanWriteL2Cache();

}

Here is the caller graph for this function:

TDbiCache* TDbiTableProxy::GetCache

(

)

[inline]

Definition at line 59 of file TDbiTableProxy.hxx.

References fCache.

Referenced by TDbiDatabaseManager::PurgeCaches().

{ return fCache;}

Here is the caller graph for this function:

TDbiCascader& TDbiTableProxy::GetCascader

(

)

[inline]

Definition at line 52 of file TDbiTableProxy.hxx.

References fCascader.

Referenced by TDbiLogEntry::Write().

{ return *fCascader; }

Here is the caller graph for this function:

const TDbiDBProxy& TDbiTableProxy::GetDBProxy

(

)

const [inline]

Definition at line 51 of file TDbiTableProxy.hxx.

References fDBProxy.

Referenced by ClassImp(), fCreationDate(), and TDbiSqlValPacket::Store().

{ return fDBProxy; }

Here is the caller graph for this function:

const TDbiTableMetaData& TDbiTableProxy::GetMetaData

(

)

const [inline]

Definition at line 53 of file TDbiTableProxy.hxx.

References fMetaData.

Referenced by TDbiSqlValPacket::AddRow(), and TDbiSqlValPacket::SetMetaData().

{ return fMetaData; }

Here is the caller graph for this function:

const TDbiTableMetaData& TDbiTableProxy::GetMetaValid

(

)

const [inline]

Definition at line 54 of file TDbiTableProxy.hxx.

References fMetaValid.

Referenced by TDbiSqlValPacket::AddRow(), TDbiSqlValPacket::Recreate(), and TDbiSqlValPacket::SetMetaData().

{ return fMetaValid; }

Here is the caller graph for this function:

string TDbiTableProxy::GetRowName

(

)

const [inline]

Definition at line 55 of file TDbiTableProxy.hxx.

References fTableRow.

Referenced by RestoreFromL2Cache(), and SaveToL2Cache().

                                           {
                      return fTableRow ? fTableRow->ClassName() : "Unknown";}

Here is the caller graph for this function:

string TDbiTableProxy::GetTableName

(

)

const [inline]

Definition at line 57 of file TDbiTableProxy.hxx.

References fTableName.

Referenced by TDbiSqlValPacket::AddRow(), TDbiDatabaseManager::ApplySqlCondition(), Query(), TDbiDatabaseManager::RefreshMetaData(), RestoreFromL2Cache(), SaveToL2Cache(), and TDbiConfigStream::Write().

{ return fTableName;}

Here is the caller graph for this function:

TDbiTableProxy& TDbiTableProxy::operator=

(

const TDbiTableProxy &

)

[private]

const TDbiResultSet * TDbiTableProxy::Query	(	const TDbiValidityRec &	vrec,
		Bool_t	canReuse = kTRUE
	)

   
     Purpose:  Apply non-agregate query to database table and return result.
   
     Arguments:
       vrec         in    The validity record that satisfies the query.
       canReuse     in    True if result is to be cached.
   
     Return:    Query result (never zero even if query fails).
   
     Contact:   N. West
   
     Specification:-
     =============
   
     o Apply non-aggregated query to main database table. Cache if required,
       and return result.
   

Definition at line 347 of file TDbiTableProxy.cxx.

References TDbiCache::Adopt(), TDbiResultSet::CaptureExceptionLog(), fCache, fCascader, fDBProxy, fTableRow, TDbiValidityRec::GetDbNo(), TDbiExceptionLog::GetGELog(), TDbiValidityRec::GetL2CacheName(), TDbiValidityRec::GetSeqNo(), GetTableName(), TDbiValidityRec::GetTableProxy(), TDbiDBProxy::QuerySeqNo(), RestoreFromL2Cache(), SaveToL2Cache(), TDbiCache::Search(), TDbiResultSet::SetCanReuse(), TDbiExceptionLog::Size(), and SK_DBI_Severe.

                                                                     {
//
//
//  Purpose:  Apply non-agregate query to database table and return result.
//
//  Arguments:
//    vrec         in    The validity record that satisfies the query.
//    canReuse     in    True if result is to be cached.
//
//  Return:    Query result (never zero even if query fails).
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Apply non-aggregated query to main database table. Cache if required,
//    and return result.


// See if it can be recovered from the level 2 disk cache.

  TDbiConnectionMaintainer cm(fCascader);  //Stack object to hold connections

// Make Global Exception Log bookmark
  UInt_t startGEL = TDbiExceptionLog::GetGELog().Size()+1;

  if ( canReuse ) {
    TDbiValidityRecBuilder builder(vrec,this->GetTableName());
    if ( this->RestoreFromL2Cache(builder) ) {
      const TDbiResultSet* res = fCache->Search(vrec);
      if ( res ) return res;
    }
  }

  unsigned int seqNo = vrec.GetSeqNo();
  TDbiResultSet* result = 0;

//  If no records, create an empty TDbiResultSet.
  if ( ! seqNo ) {
    result = new TDbiResultSetNonAgg(0,0,&vrec);
  }

//  If query does not apply to this table, report error and
//  produce an empty TDbiResultSet.

  else if (vrec.GetTableProxy()->GetTableName() != GetTableName() ) {
       SK_DBI_Severe(  "Unable to satisfy TDbiValidityRec keyed query:" << "  "
       << vrec
       << " was filled by " << vrec.GetTableProxy()->GetTableName()
       << " not by this TDbiTableProxy ("
       << GetTableName() << ")" << "  ");
    result = new TDbiResultSetNonAgg(0,0,&vrec);
  }

  else {


// Apply query, and build DiResult from its TDbiInRowStream.

    TDbiInRowStream* rs = fDBProxy.QuerySeqNo(seqNo,vrec.GetDbNo());
    result = new TDbiResultSetNonAgg(rs,fTableRow,&vrec);
    delete rs;
  }

// Record latest entries from Global Exception Log.
  result->CaptureExceptionLog(startGEL);

//  Cache in memory and on disk if required and return the results.

  fCache->Adopt(result);
  if ( canReuse ) this->SaveToL2Cache(vrec.GetL2CacheName(),*result);
  else result->SetCanReuse(kFALSE);

  return result;

}

Here is the call graph for this function:

const TDbiResultSet * TDbiTableProxy::Query	(	UInt_t	seqNo,
		UInt_t	dbNo
	)

   
     Purpose:  Apply non-agregate query to database table and return result.
   
     Arguments:
       seqNo        in    The sequence number of validity record that satisfies the query.
       dbNo         in    Database number in the cascade.
   
     Return:    Query result (never zero even if query fails).
   

Definition at line 301 of file TDbiTableProxy.cxx.

References TDbiCache::Adopt(), TDbiResultSet::CaptureExceptionLog(), fCache, fCascader, fDBProxy, TDbiExceptionLog::GetGELog(), TDbiResultSetNonAgg::GetNumRows(), TDbiResultSetNonAgg::GetTableRow(), Query(), TDbiDBProxy::QueryValidity(), and TDbiExceptionLog::Size().

                                                                   {
//
//
//  Purpose:  Apply non-agregate query to database table and return result.
//
//  Arguments:
//    seqNo        in    The sequence number of validity record that satisfies the query.
//    dbNo         in    Database number in the cascade.
//
//  Return:    Query result (never zero even if query fails).

  TDbiConnectionMaintainer cm(fCascader);  //Stack object to hold connections

// Make Global Exception Log bookmark
  UInt_t startGEL = TDbiExceptionLog::GetGELog().Size()+1;

  // Apply SEQNO query to cascade member.
  TDbiInRowStream* rs = fDBProxy.QueryValidity(seqNo,dbNo);
  TDbiValidityRec tr;
  TDbiResultSetNonAgg result(rs,&tr,0,kFALSE);
  delete rs;

  // If query failed, return an empty result.
  if ( result.GetNumRows() == 0 ) {
    TDbiResultSetNonAgg* empty = new TDbiResultSetNonAgg();
//  Record latest entries from Global Exception Log.
    empty->CaptureExceptionLog(startGEL);
    fCache->Adopt(empty);
    return empty;
  }

// Otherwise perform a validity rec query, but don't
// allow result to be used; it's validity has not been trimmed
// by neighbouring records.

  const TDbiValidityRec* vrec
       = dynamic_cast<const TDbiValidityRec*>(result.GetTableRow(0));
//  Force off const - we haven't finished with TDbiResultSet yet!
  TDbiResultSet* res = const_cast<TDbiResultSet*>(Query(*vrec,kFALSE));
// Record latest entries from Global Exception Log.
  res->CaptureExceptionLog(startGEL);
  return res;

}

Here is the call graph for this function:

const TDbiResultSet * TDbiTableProxy::Query	(	const string &	context,
		const TDbi::Task &	task,
		const string &	data,
		const string &	fillOpts
	)

     Purpose:  Apply extended context query to database table and return result.
   
     Arguments:
       context      in    The Validity Context (see TDbiSqlContext)
       task         in    The task of the query.
       data         in    Optional SQL extension to secondary query.
       fillOpts     in    Optional fill options (available to TDbiTableRow)
   
     Return:    Query result (never zero even if query fails).
   
     Contact:   N. West
   
     Specification:-
     =============
   
     o Apply extended context query to database table and return result.
   
     o Don't save/restore to L2 cache: encoding the query name as a file name
       would be cumbersome and in any case extended queries are abnormal
       so optimisation is unwarranted.
   
   
     Construct the query's "SQL Qualifiers" by forming the 3 strings
     (which task encoded into the context) into a single semi-colon
     separated string.
    

Definition at line 229 of file TDbiTableProxy.cxx.

References TDbiCache::Adopt(), TDbiResultSet::CaptureExceptionLog(), fCache, fCascader, fDBProxy, fTableName, fTableRow, TDbiExceptionLog::GetGELog(), TDbi::kAnyTask, TDbiCache::Search(), TDbiExceptionLog::Size(), and SK_DBI_Verbose.

                                                             {
//
//
//  Purpose:  Apply extended context query to database table and return result.
//
//  Arguments:
//    context      in    The Validity Context (see TDbiSqlContext)
//    task         in    The task of the query.
//    data         in    Optional SQL extension to secondary query.
//    fillOpts     in    Optional fill options (available to TDbiTableRow)
//
//  Return:    Query result (never zero even if query fails).
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Apply extended context query to database table and return result.
//
//  o Don't save/restore to L2 cache: encoding the query name as a file name
//    would be cumbersome and in any case extended queries are abnormal
//    so optimisation is unwarranted.


//  Construct the query's "SQL Qualifiers" by forming the 3 strings
//  (which task encoded into the context) into a single semi-colon
//  separated string.

  std::ostringstream os;
  os << context;
  if ( task != TDbi::kAnyTask
       ) os << " and  Task = " << task;
  os <<  ';' << data << ';' << fillOpts;
  string sqlQualifiers = os.str();

  SK_DBI_Verbose(  "Extended query: sqlQualifiers: " << sqlQualifiers << "  ");

//  See if there is one already in the cache.

  if ( const TDbiResultSet* result = fCache->Search(sqlQualifiers)
     ) return result;

  TDbiConnectionMaintainer cm(fCascader);  //Stack object to hold connections

// Make Global Exception Log bookmark
  UInt_t startGEL = TDbiExceptionLog::GetGELog().Size()+1;

// Build a complete set of effective validity records from the database.
  TDbiValidityRecBuilder builder(fDBProxy,context,task);

// For extended context queries, TDbiValidityRecBuilder will always
// assemble a result that has to be represented by a TDbiResultSetAgg

  TDbiResultSet* result = new TDbiResultSetAgg(fTableName,
                                       fTableRow,
                                       fCache,
                                       &builder,
                                       &fDBProxy,
                                       sqlQualifiers);
// Record latest entries from Global Exception Log.
  result->CaptureExceptionLog(startGEL);

  fCache->Adopt(result);
  return result;

}

Here is the call graph for this function:

const TDbiResultSet * TDbiTableProxy::Query	(	const TVldContext &	vc,
		const TDbi::Task &	task,
		Bool_t	findFullTimeWindow = true
	)

     Purpose:  Apply context specific query to database table and return result.
   
     Arguments:
       vc           in    The Validity Context for the query.
       task         in    The task of the query.
       findFullTimeWindow
                    in    Attempt to find full validity of query
                           i.e. beyond TDbi::GetTimeGate
   
     Return:    Query result (never zero even if query fails).
   
     Contact:   N. West
   
     Specification:-
     =============
   
     o Apply query to database table and return result.
   
     Program Notes:-
     =============
   
     None.
   
     See if there is one already in the cache for universal aggregate no.
    

Definition at line 137 of file TDbiTableProxy.cxx.

References TDbiCache::Adopt(), CanReadL2Cache(), TDbiResultSet::CaptureExceptionLog(), fCache, fCascader, fDBProxy, fTableName, fTableRow, TDbiExceptionLog::GetGELog(), TDbiValidityRecBuilder::GetL2CacheName(), TDbiValidityRecBuilder::GetNumValidityRec(), TDbiValidityRecBuilder::GetValidityRec(), TDbiValidityRec::IsGap(), TDbiValidityRecBuilder::NonAggregated(), RestoreFromL2Cache(), SaveToL2Cache(), TDbiCache::Search(), TDbiExceptionLog::Size(), and SK_DBI_Info.

Referenced by Query().

                                                                 {
//
//
//  Purpose:  Apply context specific query to database table and return result.
//
//  Arguments:
//    vc           in    The Validity Context for the query.
//    task         in    The task of the query.
//    findFullTimeWindow
//                 in    Attempt to find full validity of query
//                        i.e. beyond TDbi::GetTimeGate
//
//  Return:    Query result (never zero even if query fails).
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Apply query to database table and return result.

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

//  None.

//  See if there is one already in the cache for universal aggregate no.

  if ( const TDbiResultSet* result = fCache->Search(vc,task)
     ) return result;

  TDbiConnectionMaintainer cm(fCascader);  //Stack object to hold connections

// Make Global Exception Log bookmark
  UInt_t startGEL = TDbiExceptionLog::GetGELog().Size()+1;

// Build a complete set of effective validity record from the database.
  TDbiValidityRecBuilder builder(fDBProxy,vc,task,-1,findFullTimeWindow);

// Deal with non-aggregated data.

  if ( builder.NonAggregated() ) {

    TDbiValidityRec effVRec = builder.GetValidityRec(0);
//  Force off const - we haven't finished with TDbiResultSet yet!
    TDbiResultSet* result = const_cast<TDbiResultSet*>(Query(effVRec));
//  Record latest entries from Global Exception Log.
    result->CaptureExceptionLog(startGEL);
    return result;
  }

// Deal with aggregated data.

// Don't look in the level 2 cache if more than half of the
// component aggregates are already in the cache;
// for in this case, the chances are that we have just
// crossed a validity boundary in only a few aggregates and
// we don't want to waste time loading in a full set only to throw
// it away again.

  if ( this->CanReadL2Cache() ) {
    UInt_t numPresent  = 0;
    UInt_t numRequired = 0;
    Int_t maxRow = builder.GetNumValidityRec() - 1;
    for ( Int_t rowNo = 1; rowNo <= maxRow; ++rowNo ) {
      const TDbiValidityRec& vrec = builder.GetValidityRec(rowNo);
      if ( fCache->Search(vrec) ) ++numPresent;
      else if ( ! vrec.IsGap() ) ++numRequired;
    }
    if ( numRequired < numPresent ) SK_DBI_Info(  "Skipping search of L2 cache; already have "
      << numPresent << " aggregates, and only require a further "
      << numRequired << "  ");
    else this->RestoreFromL2Cache(builder);
  }

  TDbiResultSet* result = new TDbiResultSetAgg(fTableName,
                                       fTableRow,
                                       fCache,
                                       &builder,
                                       &fDBProxy);
// Record latest entries from Global Exception Log.
  result->CaptureExceptionLog(startGEL);

  fCache->Adopt(result);
  this->SaveToL2Cache(builder.GetL2CacheName(),*result);
  return result;

}

Here is the call graph for this function:

Here is the caller graph for this function:

TVldTimeStamp TDbiTableProxy::QueryOverlayCreationDate	(	const TDbiValidityRec &	vrec,
		UInt_t	dbNo
	)

   
     Purpose:  Determine a suitable Creation Date so that this validity
               record, if written to the selected DB, will overlay
               correctly.
   
     Specification:-
     =============
   
     o Determine optimal Creation Date to overlay new data.  See Program Notes.
   
     Program Notes:-
     =============
   
   
    It is normal practice, particularly for calibration data, to have
    overlapping the validity records.  Each time a new set of runs are
    processed the start time of the validity is set to the start time of
    the first run and the end time is set beyond the start time by an
    interval that characterises the stability of the constants.  So long
    as a new set of constants is created before the end time is reached
    there will be no gap.  Where there is an overlap the Creation Date is
    used to select the later constants on the basis that later is better.
    However, if reprocessing old data it is also normal practice to
    process recent data first and in this case the constants for earlier
    data get later creation dates and overlay works the wrong way.  To
    solve this, the creation date is faked as follows:-
   
   
      1.  For new data i.e. data that does not overlay any existing data,
          the creation date is set to the validity start time.
   
      2.  For replacement data i.e. data that does overlay existing data,
          the creation date is set to be one minute greater than the Creation
          Date on the current best data.
   
    This scheme ensures that new data will overlay existing data at the
    start of its validity but will be itself overlaid by data that has
    a later start time (assuming validity record start times are more
    than a few minutes apart)
   
   

Definition at line 440 of file TDbiTableProxy.cxx.

References fCascader, fDBProxy, TDbiValidityRec::GetAggregateNo(), TDbiValidityRec::GetTask(), TDbiValidityRec::GetVldRange(), and SK_DBI_Debug.

{
//
//  Purpose:  Determine a suitable Creation Date so that this validity
//            record, if written to the selected DB, will overlay
//            correctly.
//
//  Specification:-
//  =============
//
//  o Determine optimal Creation Date to overlay new data.  See Program Notes.

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


// It is normal practice, particularly for calibration data, to have
// overlapping the validity records.  Each time a new set of runs are
// processed the start time of the validity is set to the start time of
// the first run and the end time is set beyond the start time by an
// interval that characterises the stability of the constants.  So long
// as a new set of constants is created before the end time is reached
// there will be no gap.  Where there is an overlap the Creation Date is
// used to select the later constants on the basis that later is better.
// However, if reprocessing old data it is also normal practice to
// process recent data first and in this case the constants for earlier
// data get later creation dates and overlay works the wrong way.  To
// solve this, the creation date is faked as follows:-
//
//
//   1.  For new data i.e. data that does not overlay any existing data,
//       the creation date is set to the validity start time.
//
//   2.  For replacement data i.e. data that does overlay existing data,
//       the creation date is set to be one minute greater than the Creation
//       Date on the current best data.
//
// This scheme ensures that new data will overlay existing data at the
// start of its validity but will be itself overlaid by data that has
// a later start time (assuming validity record start times are more
// than a few minutes apart)


  //  Create a context that corresponds to the start time of the validity
  //  range.  Note that it is O.K. to use SimFlag and Detector masks
  //  even though this could make the context ambiguous because the
  //  context is only to be used to query the database and the SimFlag and
  //  Detector values will be ORed against existing data so will match
  //  all possible data that this validity range could overlay which is
  //  just what we want.

  const TVldRange& vr(vrec.GetVldRange());
  TVldContext vc((DbiDetector::Detector_t) vr.GetDetectorMask(),
                  (DbiSimFlag::SimFlag_t) vr.GetSimMask(),
                                       vr.GetTimeStart());

  TDbiConnectionMaintainer cm(fCascader);  //Stack object to hold connections

  // Build a complete set of effective validity records from the
  // selected database.
  TDbiValidityRecBuilder builder(fDBProxy,vc,vrec.GetTask(),dbNo);

  // Pick up the validity record for the current aggregate.
  const TDbiValidityRec& vrecOvlay(builder.GetValidityRecFromAggNo(vrec.GetAggregateNo()));

  // If its a gap i.e. nothing is overlayed, return the start time, otherwise
  // return its Creation Date plus one minute.
  TVldTimeStamp ovlayTS(vr.GetTimeStart());
  if ( ! vrecOvlay.IsGap() ) {
    time_t overlaySecs = vrecOvlay.GetCreationDate().GetSec();
    ovlayTS = TVldTimeStamp(overlaySecs + 60,0);
  }

  SK_DBI_Debug( "Looking for overlay creation date for: "
                   << vrec << "found it would overlap: "
                   << vrecOvlay << " so overlay creation date set to "
                   << ovlayTS.AsString("s") << "  ");
  return ovlayTS;

}

Here is the call graph for this function:

void TDbiTableProxy::RefreshMetaData

(

)

Purpose: Refresh meta data for table.

Definition at line 428 of file TDbiTableProxy.cxx.

References fDBProxy, fMetaData, fMetaValid, and TDbiDBProxy::StoreMetaData().

Referenced by TDbiDatabaseManager::RefreshMetaData().

                                     {
//
//
//  Purpose:  Refresh meta data for table.
//

  fDBProxy.StoreMetaData(fMetaData);
  fDBProxy.StoreMetaData(fMetaValid);

}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbiTableProxy::RestoreFromL2Cache

(

const TDbiValidityRecBuilder &

builder

)

[private]

   
     Purpose: Restore results from named level 2 disk cache into memory cache.
     Returns true if anything restored
   
     Specification:-
     =============
   
     o Restore to cache but only if enabled and exists.
   

Definition at line 523 of file TDbiTableProxy.cxx.

References TDbiCache::Adopt(), CanReadL2Cache(), fCache, TDbiValidityRecBuilder::GetL2CacheName(), GetRowName(), TDbiValidityRec::GetSeqNo(), GetTableName(), TDbiResultSet::GetValidityRec(), TDbiValidityRecBuilder::GetValidityRecFromSeqNo(), TDbiTimerManager::gTimerManager, TDbiTimerManager::RecMainQuery(), TDbiCache::Search(), SK_DBI_Debug, SK_DBI_Info, and SK_DBI_Warn.

Referenced by Query().

                                                                               {
//
//
//  Purpose: Restore results from named level 2 disk cache into memory cache.
//  Returns true if anything restored

//  Specification:-
//  =============
//
//  o Restore to cache but only if enabled and exists.

  const string name(builder.GetL2CacheName());
  SK_DBI_Debug( "Request to restore query result  " << name
                         << "  ");
  if ( ! this->CanReadL2Cache() ) return kFALSE;
  string cacheFileName;
  if (  name != ""
   ) cacheFileName =  this->GetTableName() + "_"
                    + this->GetRowName() + "_"
                    +  name + ".dbi_cache";
  TDbiBinaryFile bf(cacheFileName.c_str());
  if ( ! bf.IsOK() ) {
    SK_DBI_Debug( "Caching disabled or cannot open "
                           << bf.GetFileName() << "  ");
    return kFALSE;
  }

  static bool warnOnce = true;
  if ( warnOnce ) {
    SK_DBI_Warn( "\n\n\n"
     << " WARNING:  Reading from the Level 2 cache has been activated.\n"
     << " *******   This should only be used for development and never for production !!!\n\n\n");
    warnOnce = false;
  }

  SK_DBI_Info( "Restoring query result from " << bf.GetFileName() << "  ");
  TDbiTimerManager::gTimerManager.RecMainQuery();

  TDbiResultSet* result    = 0;
  unsigned numRowsRest = 0;
  unsigned numRowsIgn  = 0;
  UInt_t numNonAgg     = 0;
  bf >> numNonAgg;

  while ( numNonAgg-- ) {
    if ( ! bf.IsOK() ) break;
    if ( ! result ) result = new TDbiResultSetNonAgg;
    bf >> *result;

//  The original query may have had a validity range truncated by
//  the time window, so replace its TDbiValidityRec with the one
//  just obtained from the database.
    const TDbiValidityRec& vrec = result->GetValidityRec();
    UInt_t seqNo = vrec.GetSeqNo();
    SK_DBI_Debug( "Fix up L2 cache TDbiValidityRec, by replacing: " << vrec
                           << "    with: " << builder.GetValidityRecFromSeqNo(seqNo) << "  ");
//  Sneaky end-run round const to fix-up TDbiValidityRec.
    (const_cast<TDbiValidityRec&>(vrec)) = builder.GetValidityRecFromSeqNo(seqNo);

//  Adopt only if not already in memory cache.
    if ( ! fCache->Search(vrec) ) {
      numRowsRest += result->GetNumRows();
      fCache->Adopt(result);
      result = 0;
    }
    else numRowsIgn += result->GetNumRows();
  }
  SK_DBI_Info( "   a total of " << numRowsRest << " were restored ("
                        << numRowsIgn << " ignored - already in memory)" << "  ");

  delete result;
  result = 0;

  return numRowsRest > 0;

}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbiTableProxy::SaveToL2Cache	(	const string &	name,
		TDbiResultSet &	res
	)			[private]

   
     Purpose: Save result to named level 2 cache. Returns true if saved.
   
     Specification:-
     =============
   
     o Save to cache but only if enabled and suitable.
   

Definition at line 601 of file TDbiTableProxy.cxx.

References TDbiResultSet::CanSave(), CanWriteL2Cache(), TDbiBinaryFile::CanWriteL2Cache(), fCanL2Cache, TDbiResultSet::GetNumRows(), GetRowName(), GetTableName(), TDbiTimerManager::gTimerManager, TDbiTimerManager::RecMainQuery(), TDbiResultSet::ResultsFromDb(), SK_DBI_Debug, and SK_DBI_Info.

Referenced by Query().

                                                                           {
//
//
//  Purpose: Save result to named level 2 cache. Returns true if saved.

//  Specification:-
//  =============
//
//  o Save to cache but only if enabled and suitable.

  SK_DBI_Debug( "Request to save query result as " << name
                         << " ; row supports L2 cache ?"<<fCanL2Cache
                         << " ; binary file can write L2 Cache?"<< TDbiBinaryFile::CanWriteL2Cache()
                         << " ; data from DB? " << res.ResultsFromDb()
                         << " ; can be saved? " << res.CanSave() << "  ");
  if ( ! this->CanWriteL2Cache() || ! res.ResultsFromDb() || ! res.CanSave() ) return kFALSE;

  string cacheFileName;
  if (  name != ""
   ) cacheFileName =  this->GetTableName() + "_"
                    + this->GetRowName() + "_"
                    +  name + ".dbi_cache";
  TDbiBinaryFile bf(cacheFileName.c_str(),kFALSE);
  if ( bf.IsOK() ) {
    SK_DBI_Info( "Saving query result (" << res.GetNumRows()
                          << " rows) to " << bf.GetFileName() << "  ");
     TDbiTimerManager::gTimerManager.RecMainQuery();

    // if writing a TDbiResultSetNonAgg, add leading count of 1. (if writing
    // a TDbiResultSetAgg it will writes its one leading count.
    if ( dynamic_cast<TDbiResultSetNonAgg*>(&res) ) {
      UInt_t numNonAgg = 1;
      bf << numNonAgg;
    }
    bf << res;
    return kTRUE;
  }
  SK_DBI_Debug( "Caching disabled or cannot open "
                         << bf.GetFileName() << "  ");
  return kFALSE;

}

Here is the call graph for this function:

Here is the caller graph for this function:

void TDbiTableProxy::SetSqlCondition

(

const string &

sql

)

   
     Purpose:  Apply Sql condition to its TDbiDBProxy.
   
     Arguments:
      sql           in    SQL condition string (excluding where).
   
     Return:  n/a
   
     Contact:   N. West
   
     Specification:-
     =============
   
     o Apply Sql condition to its TDbiDBProxy.
   
     Program Notes:-
     =============
   
     None.
   

Definition at line 645 of file TDbiTableProxy.cxx.

References fDBProxy, and TDbiDBProxy::SetSqlCondition().

Referenced by TDbiDatabaseManager::ApplySqlCondition().

                                                      {
//
//
//  Purpose:  Apply Sql condition to its TDbiDBProxy.
//
//  Arguments:
//   sql           in    SQL condition string (excluding where).
//
//  Return:  n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Apply Sql condition to its TDbiDBProxy.

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

//  None.

  fDBProxy.SetSqlCondition(sql);

}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbiTableProxy::TableExists

(

)

const [inline]

Definition at line 225 of file TDbiTableProxy.hxx.

References fExists.

{ return fExists; }

---

Friends And Related Function Documentation

friend class TDbiDatabaseManager [friend]

Definition at line 46 of file TDbiTableProxy.hxx.

---

Member Data Documentation

TDbiCache* TDbiTableProxy::fCache [private]

Associated cache for result.

Definition at line 307 of file TDbiTableProxy.hxx.

Referenced by GetCache(), Query(), RestoreFromL2Cache(), and ~TDbiTableProxy().

Bool_t TDbiTableProxy::fCanL2Cache [private]

True if row supports L2 cache.

Definition at line 304 of file TDbiTableProxy.hxx.

Referenced by CanReadL2Cache(), CanWriteL2Cache(), and SaveToL2Cache().

TDbiCascader* TDbiTableProxy::fCascader [private]

Pointer to one and only cascader.

Definition at line 295 of file TDbiTableProxy.hxx.

Referenced by GetCascader(), Query(), and QueryOverlayCreationDate().

TDbiDBProxy TDbiTableProxy::fDBProxy [private]

Proxy to database.

Definition at line 310 of file TDbiTableProxy.hxx.

Referenced by GetDBProxy(), Query(), QueryOverlayCreationDate(), RefreshMetaData(), and SetSqlCondition().

Bool_t TDbiTableProxy::fExists [private]

true if table exists;

Definition at line 313 of file TDbiTableProxy.hxx.

Referenced by TableExists().

TDbiTableMetaData TDbiTableProxy::fMetaData [private]

Meta data for main(data) table.

Definition at line 298 of file TDbiTableProxy.hxx.

Referenced by GetMetaData(), and RefreshMetaData().

TDbiTableMetaData TDbiTableProxy::fMetaValid [private]

Meta data for aux. (validity)table.

Definition at line 301 of file TDbiTableProxy.hxx.

Referenced by GetMetaValid(), and RefreshMetaData().

string TDbiTableProxy::fTableName [private]

Table Name.

Definition at line 316 of file TDbiTableProxy.hxx.

Referenced by GetTableName(), Query(), and ~TDbiTableProxy().

TDbiTableRow* TDbiTableProxy::fTableRow [private]

Pet object used to create new rows.

Definition at line 319 of file TDbiTableProxy.hxx.

Referenced by GetRowName(), Query(), and ~TDbiTableProxy().

---

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

• src/TDbiTableProxy.hxx
• src/TDbiTableProxy.cxx