EcalCondDBInterface.h

Go to the documentation of this file.

/***********************************************/
/* EcalCondDBInterface.h               */
/*                         */
/*                         */
/* Interface to the Ecal Conditions DB.        */
/***********************************************/

#ifndef ECALCONDDBINTERFACE_HH
#define ECALCONDDBINTERFACE_HH

#include <iostream>
#include <string>
#include <vector>
#include <map>
#include <stdexcept>
#include "OnlineDB/Oracle/interface/Oracle.h"

#include "OnlineDB/EcalCondDB/interface/EcalDBConnection.h"
#include "OnlineDB/EcalCondDB/interface/Tm.h"
#include "OnlineDB/EcalCondDB/interface/EcalLogicID.h"
#include "OnlineDB/EcalCondDB/interface/IIOV.h"
#include "OnlineDB/EcalCondDB/interface/RunIOV.h"
#include "OnlineDB/EcalCondDB/interface/MonRunIOV.h"
#include "OnlineDB/EcalCondDB/interface/DCUIOV.h"
#include "OnlineDB/EcalCondDB/interface/CaliIOV.h"
#include "OnlineDB/EcalCondDB/interface/RunList.h"
#include "OnlineDB/EcalCondDB/interface/MonRunList.h"
#include "OnlineDB/EcalCondDB/interface/MonRunTag.h"
#include "OnlineDB/EcalCondDB/interface/DCSPTMTempList.h"
#include "OnlineDB/EcalCondDB/interface/all_fe_config_types.h"
#include "OnlineDB/EcalCondDB/interface/all_lmf_types.h"
#include "OnlineDB/EcalCondDB/interface/all_od_types.h"

#include "DataFormats/EcalDetId/interface/EEDetId.h"
#include "DataFormats/EcalDetId/interface/EBDetId.h"

class EcalCondDBInterface : public EcalDBConnection {
public:
  /******************\
  -  public methods  -
  \******************/

  EcalCondDBInterface(std::string host, std::string sid, std::string user, std::string pass, int port = 1521)
      : EcalDBConnection(host, sid, user, pass, port) {
    // call the parent constructor

    // create a DateHandler
    dh = new DateHandler(env, conn);
  }

  EcalCondDBInterface(std::string sid, std::string user, std::string pass) : EcalDBConnection(sid, user, pass) {
    // call the parent constructor

    // create a DateHandler
    dh = new DateHandler(env, conn);
  }

  ~EcalCondDBInterface() noexcept(false) override {
    // call the parent destructor

    // destroy the DateHandler
    delete (dh);
  }

  inline DateHandler* getDateHandler() { return dh; }

  EcalLogicID getEcalLogicID(std::string name,
                             int id1 = EcalLogicID::NULLID,
                             int id2 = EcalLogicID::NULLID,
                             int id3 = EcalLogicID::NULLID,
                             std::string mapsTo = "") noexcept(false);

  std::vector<EcalLogicID> getEcalLogicIDMappedTo(int logic_id, std::string maps_to);

  std::vector<EcalLogicID> getEcalLogicIDForLMR(int lmr_logic_id);
  std::vector<EcalLogicID> getEcalLogicIDForLMR(const EcalLogicID& lmr_logic_id);
  std::vector<EcalLogicID> getEcalLogicIDForLMPN(int lmr_logic_id);
  std::vector<EcalLogicID> getEcalLogicIDForLMPN(const EcalLogicID& lmr_logic_id);

  EcalLogicID getEcalLogicID(int logicID) noexcept(false);

  std::vector<EcalLogicID> getEcalLogicIDSet(std::string name,
                                             int fromId1 = EcalLogicID::NULLID,
                                             int toId1 = EcalLogicID::NULLID,
                                             int fromId2 = EcalLogicID::NULLID,
                                             int toId2 = EcalLogicID::NULLID,
                                             int fromId3 = EcalLogicID::NULLID,
                                             int toId3 = EcalLogicID::NULLID,
                                             std::string mapsTo = "") noexcept(false);

  std::map<int, int> getEcalLogicID2LmrMap();
  std::vector<EcalLogicID> getEcalLogicIDSetOrdered(std::string name,
                                                    int fromId1,
                                                    int toId1,
                                                    int fromId2 = EcalLogicID::NULLID,
                                                    int toId2 = EcalLogicID::NULLID,
                                                    int fromId3 = EcalLogicID::NULLID,
                                                    int toId3 = EcalLogicID::NULLID,
                                                    std::string mapsTo = "",
                                                    int orderedBy = EcalLogicID::NULLID) noexcept(false);

  void insertRunIOV(RunIOV* iov) noexcept(false);
  // updates the end time of an iov
  void updateRunIOV(RunIOV* iov) noexcept(false);
  void updateRunIOVStartTime(RunIOV* iov) noexcept(false);
  void updateRunIOVEndTime(RunIOV* iov) noexcept(false);

  void updateRunConfig(ODRunConfigInfo* od) noexcept(false);

  void insertLmfIOV(LMFIOV* iov) noexcept(false);
  void insertLmfLmrSubIOV(LMFLmrSubIOV* iov) noexcept(false);
  void insertLmfSeq(LMFSeqDat* iov) noexcept(false);
  void insertLmfRunIOV(LMFRunIOV* iov) noexcept(false);
  void insertLmfDat(LMFDat* dat) noexcept(false);
  void insertLmfDat(std::list<LMFDat*> dat) noexcept(false);

  std::list<ODDelaysDat> fetchFEDelaysForRun(RunIOV* iov) noexcept(false);

  RunIOV fetchRunIOV(RunTag* tag, run_t run) noexcept(false);

  RunIOV fetchRunIOV(std::string location, run_t run) noexcept(false);

  RunIOV fetchRunIOV(std::string location, const Tm& t) noexcept(false);

  void insertMonRunIOV(MonRunIOV* iov) noexcept(false);

  void insertDCUIOV(DCUIOV* iov) noexcept(false);

  MonRunIOV fetchMonRunIOV(RunTag* runtag, MonRunTag* montag, run_t run, subrun_t monrun) noexcept(false);

  DCUIOV fetchDCUIOV(DCUTag* tag, const Tm& evenTm) noexcept(false);

  LMFRunIOV fetchLMFRunIOV(RunTag* runtag, LMFRunTag* lmftag, run_t run, subrun_t lmfrun) noexcept(false);
  bool fetchLMFRunIOV(const LMFSeqDat&, LMFRunIOV&, int lmr, int type, int color) const;
  RunIOV fetchLMFLastRun() const;

  CaliIOV fetchCaliIOV(CaliTag* tag, const Tm& evenTm) noexcept(false);

  RunList fetchRunList(const RunTag& tag) noexcept(false);
  RunList fetchRunList(const RunTag& tag, int min_run, int max_run) noexcept(false);
  RunList fetchNonEmptyRunList(const RunTag& tag, int min_run, int max_run) noexcept(false);
  RunList fetchNonEmptyGlobalRunList(const RunTag& tag, int min_run, int max_run) noexcept(false);
  RunList fetchRunListByLocation(const RunTag& tag, int min_run, int max_run, const LocationDef& locDef) noexcept(false);
  RunList fetchGlobalRunListByLocation(const RunTag& tag,
                                       int min_run,
                                       int max_run,
                                       const LocationDef& locDef) noexcept(false);
  RunList fetchRunListLastNRuns(const RunTag& tag, int max_run, int n_runs) noexcept(false);

  DCSPTMTempList fetchDCSPTMTempList(const EcalLogicID& ecid) noexcept(false);
  DCSPTMTempList fetchDCSPTMTempList(const EcalLogicID& ecid, const Tm& start, const Tm& end) noexcept(false);

  MonRunList fetchMonRunList(const RunTag& tag, const MonRunTag& monruntag) noexcept(false);
  MonRunList fetchMonRunList(const RunTag& tag, const MonRunTag& monruntag, int min_run, int max_run) noexcept(false);
  MonRunList fetchMonRunListLastNRuns(const RunTag& tag,
                                      const MonRunTag& monruntag,
                                      int max_run,
                                      int n_runs) noexcept(false);

  /*
   *   Insert a set of data at the given iov.  If the iov does not yet
   *   exist in the database they will be written.  Nothing is committed in the the event of
   *   an exception
   */
  // XXX TODO:  Split declaration and definition using a macro
  // XXX        Naive method causes linker errors...
  // XXX        See example FWCore/Framework/interface/eventSetupGetImplementation.h

  template <class DATT, class IOVT>
  void insertDataSet(const std::map<EcalLogicID, DATT>* data, IOVT* iov) noexcept(false) {
    try {
      iov->setConnection(env, conn);
      // if it has not yet been written then write
      if (iov->getID() == 0) {
        std::cout << "IOV was not set we retrieve it from DB" << std::endl;
        iov->fetchID();
      }
      if (iov->getID() == 0) {
        std::cout << "IOV was not written we write it" << std::endl;
        iov->writeDB();
      }

      DATT dataIface;
      dataIface.setConnection(env, conn);
      dataIface.prepareWrite();

      const EcalLogicID* channel;
      const DATT* dataitem;
      typedef typename std::map<EcalLogicID, DATT>::const_iterator CI;
      for (CI p = data->begin(); p != data->end(); ++p) {
        channel = &(p->first);
        dataitem = &(p->second);
        dataIface.writeDB(channel, dataitem, iov);
      }
      conn->commit();
      dataIface.terminateWriteStatement();
    } catch (std::runtime_error& e) {
      conn->rollback();
      throw(e);
    } catch (...) {
      conn->rollback();
      throw(std::runtime_error("EcalCondDBInterface::insertDataSet:  Unknown exception caught"));
    }
  }

  //test for DB Array insertion
  template <class DATT, class IOVT>
  void insertDataArraySet(const std::map<EcalLogicID, DATT>* data, IOVT* iov) noexcept(false) {
    try {
      iov->setConnection(env, conn);
      if (iov->getID() == 0) {
        std::cout << "IOV was not set we retrieve it from DB" << std::endl;
        iov->fetchID();
      }
      if (iov->getID() == 0) {
        std::cout << "IOV was not written we write it" << std::endl;
        iov->writeDB();
      }

      std::cout << "id=" << iov->getID() << std::endl;

      DATT dataIface;
      dataIface.setConnection(env, conn);
      dataIface.prepareWrite();

      dataIface.writeArrayDB(data, iov);
      conn->commit();

      dataIface.terminateWriteStatement();

    } catch (std::runtime_error& e) {
      conn->rollback();
      throw(e);
    } catch (...) {
      conn->rollback();
      throw(std::runtime_error("EcalCondDBInterface::insertDataSet:  Unknown exception caught"));
    }
  }

  template <class DATT, class IOVT>
  void insertDataSetVector(const std::vector<EcalLogicID>& ecid,
                           const std::vector<IOVT>& run_iov,
                           const std::vector<DATT>& data) noexcept(false) {
    int nruns = run_iov.size();

    if (run_iov.size() != ecid.size() && ecid.size() != data.size()) {
      throw(std::runtime_error("EcalCondDBInterface::insertDataSetVector:  vector sizes are different.."));
    }

    try {
      DATT dataIface;
      dataIface.setConnection(env, conn);
      dataIface.prepareWrite();

      for (int i = 0; i < nruns; i++) {
        run_iov[i].setConnection(env, conn);
        run_iov[i].writeDB();

        dataIface.writeDB(&ecid[i], &data[i], &run_iov[i]);

        conn->commit();
      }
    } catch (std::runtime_error& e) {
      conn->rollback();
      throw(e);
    } catch (...) {
      conn->rollback();
      throw(std::runtime_error("EcalCondDBInterface::insertDataSet:  Unknown exception caught"));
    }
  }

  // CONFIG DB methods

  template <class ICONF>
  void insertConfigSet(ICONF* iconf) noexcept(false) {
    try {
      iconf->setConnection(env, conn);
      iconf->prepareWrite();
      // if it has not yet been written then write
      iconf->writeDB();
      std::cout << "iconf inserted with ID=" << iconf->getId() << std::endl;
      conn->commit();
      iconf->terminateWriteStatement();
    } catch (std::runtime_error& e) {
      conn->rollback();
      throw(e);
    } catch (...) {
      conn->rollback();
      throw(std::runtime_error("EcalCondDBInterface::insertDataSet:  Unknown exception caught"));
    }
  }

  /*
   *  Fetch a config set
   */
  template <class ICONF>
  void fetchConfigSet(ICONF* iconf) noexcept(false) {
    iconf->clear();
    iconf->setConnection(env, conn);
    iconf->createReadStatement();
    iconf->fetchData(iconf);
    iconf->terminateReadStatement();
  }

  /*
   *  Fetch a config set
   */
  template <class ICONF>
  void fetchLastConfigSet(ICONF* iconf) noexcept(false) {
    iconf->clear();
    iconf->setConnection(env, conn);
    iconf->createReadStatement();
    iconf->fetchLastData(iconf);
    iconf->terminateReadStatement();
  }

  /*
   *  Insert a config data set 
   */
  template <class DATT, class ICONF>
  void insertConfigDataSet(const std::vector<DATT> data, ICONF* iconf) noexcept(false) {
    try {
      iconf->setConnection(env, conn);
      // if it has not yet been written then write
      if (iconf->getId() == 0) {
        std::cout << "EcalCondDBInterface>> config_id was not set we retrieve it from DB" << std::endl;
        iconf->fetchID();
      }
      if (iconf->getId() == 0) {
        std::cout << "EcalCondDBInterface>> configuration info was not written we write it" << std::endl;
        iconf->writeDB();
      }

      DATT dataIface;
      dataIface.setConnection(env, conn);
      dataIface.prepareWrite();

      const DATT* dataitem;

      for (int p = 0; p != data->size(); ++p) {
        dataitem = data[p];
        dataIface.writeDB(dataitem, iconf);
      }
      conn->commit();
      dataIface.terminateWriteStatement();
    } catch (std::runtime_error& e) {
      conn->rollback();
      throw(e);
    } catch (...) {
      conn->rollback();
      throw(std::runtime_error("EcalCondDBInterface::insertConfigDataSet:  Unknown exception caught"));
    }
  }
  /*
   *  insert a config data set array fast
   */
  template <class DATT, class ICONF>
  void insertConfigDataArraySet(const std::vector<DATT>& data, ICONF* iconf) noexcept(false) {
    try {
      iconf->setConnection(env, conn);
      // if it has not yet been written then write
      if (iconf->getId() == 0) {
        std::cout << "EcalCondDBInterface>> config_id was not set we retrieve it from DB" << std::endl;
        iconf->fetchID();
      }
      if (iconf->getId() == 0) {
        std::cout << "EcalCondDBInterface>> configuration info was not written we write it" << std::endl;
        iconf->writeDB();
      }

      DATT dataIface;
      dataIface.setConnection(env, conn);
      dataIface.prepareWrite();

      dataIface.writeArrayDB(data, iconf);
      conn->commit();

      dataIface.terminateWriteStatement();

    } catch (std::runtime_error& e) {
      conn->rollback();
      throw(e);
    } catch (...) {
      conn->rollback();
      throw(std::runtime_error("EcalCondDBInterface::insertConfigDataArraySet:  Unknown exception caught"));
    }
  }
  /*
   *  Fetch a set of data based on an EXACT match of an iov
   */
  template <class DATT, class ICONF>
  void fetchConfigDataSet(std::vector<DATT>* fillMap, ICONF* iconf) noexcept(false) {
    DATT datiface;
    datiface.setConnection(env, conn);
    datiface.createReadStatement();
    datiface.setPrefetchRowCount(1024);
    datiface.fetchData(fillMap, iconf);
    datiface.terminateReadStatement();
  }

  /*
   *  Fetch a set of data based on an EXACT match of an iov
   */
  template <class DATT, class IOVT>
  void fetchDataSet(std::map<EcalLogicID, DATT>* fillMap, IOVT* iov) noexcept(false) {
    fillMap->clear();

    DATT datiface;
    datiface.setConnection(env, conn);
    datiface.createReadStatement();
    datiface.setPrefetchRowCount(1024);
    datiface.fetchData(fillMap, iov);
    datiface.terminateReadStatement();
  }

  /*                               
   *  Fetch a set of DCS data based on time stamp
   */
  template <class DATT>
  void fetchDCSDataSet(std::list<std::pair<Tm, std::map<EcalLogicID, DATT> > >* fillMap, const Tm& t) noexcept(false) {
    fillMap->clear();

    DATT datiface;
    datiface.setConnection(env, conn);
    datiface.createReadStatement();
    datiface.setPrefetchRowCount(1024);
    datiface.fetchHistoricalData(fillMap, t);
    datiface.terminateReadStatement();
  }

  /*
   *  Fetch a set of data based on an EXACT match of an iov
   * with a specific mapping name 
   */
  template <class DATT, class IOVT>
  void fetchDataSetWithMap(std::map<EcalLogicID, DATT>* fillMap, IOVT* iov, std::string mapping_name) noexcept(false) {
    fillMap->clear();

    DATT datiface;
    datiface.setConnection(env, conn);
    datiface.createReadStatement();
    datiface.setPrefetchRowCount(1024);
    datiface.fetchData(fillMap, iov, mapping_name);
    datiface.terminateReadStatement();
  }

  /*
   *  Fetch dataset that is valid for the given RunTag and run.
   *  Also fills the given IOV object with the IOV associated with the data
   *  run is optional, by default is set to infinity
   *  Note:  ONLY works for Run*Dat objects
   *  TODO:  Make this function (or similar) work for all *Dat objects
   */
  template <class DATT, class IOVT>
  void fetchValidDataSet(std::map<EcalLogicID, DATT>* fillMap,
                         IOVT* fillIOV,
                         RunTag* tag,
                         run_t run = (unsigned int)-1) noexcept(false) {
    fillMap->clear();
    DATT datiface;
    fillIOV->setConnection(env, conn);
    fillIOV->setByRecentData(datiface.getTable(), tag, run);
    datiface.setConnection(env, conn);
    datiface.createReadStatement();
    datiface.setPrefetchRowCount(1024);
    datiface.fetchData(fillMap, fillIOV);
    datiface.terminateReadStatement();
  }

  /*
   *  Fetch dataset that is valid for the given location and run.
   *  Also fills the given IOV object with the IOV associated with the data
   *  run is optional, by default is set to infinity
   *  Note:  ONLY works for Run*Dat objects
   *  TODO:  Make this function (or similar) work for all *Dat objects
   */
  template <class DATT, class IOVT>
  void fetchValidDataSet(std::map<EcalLogicID, DATT>* fillMap,
                         IOVT* fillIOV,
                         std::string location,
                         run_t run = (unsigned int)-1) noexcept(false) {
    fillMap->clear();
    DATT datiface;
    fillIOV->setConnection(env, conn);
    fillIOV->setByRecentData(datiface.getTable(), location, run);
    datiface.setConnection(env, conn);
    datiface.createReadStatement();
    datiface.setPrefetchRowCount(1024);
    datiface.fetchData(fillMap, fillIOV);
    datiface.terminateReadStatement();
  }

  inline int getDetIdFromLogicId(int logic_id) {
    int detid = -1;
    if (_logicId2DetId.empty()) {
      fillLogicId2DetIdMaps();
    }
    if (_logicId2DetId.find(logic_id) != _logicId2DetId.end()) {
      detid = _logicId2DetId[logic_id];
    }
    return detid;
  }

  inline int getLogicIdFromDetId(int det_id) {
    int logic_id = -1;
    if (_logicId2DetId.empty()) {
      fillLogicId2DetIdMaps();
    }
    if (_detId2LogicId.find(det_id) != _detId2LogicId.end()) {
      logic_id = _detId2LogicId[det_id];
    }
    return logic_id;
  }

  inline std::map<int, int> getLogicId2DetIdMap() {
    if (_logicId2DetId.empty()) {
      fillLogicId2DetIdMaps();
    }
    return _logicId2DetId;
  }

  inline std::map<int, int> getDetId2LogicIdMap() {
    if (_logicId2DetId.empty()) {
      fillLogicId2DetIdMaps();
    }
    return _detId2LogicId;
  }

  void dummy();

private:
  void fillLogicId2DetIdMaps();

  /*********************\
  -  private variables  -
  \*********************/

  DateHandler* dh;

  std::map<int, int> _logicId2DetId;
  std::map<int, int> _detId2LogicId;

public:
  EcalCondDBInterface() = delete;
  EcalCondDBInterface(const EcalCondDBInterface& copy) = delete;
};

#endif